Skip to content

Fixed APP_URL documentation. #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fixed APP_URL documentation. #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ docker create \
-e DB_USER=<yourdbuser> \
-e DB_PASS=<yourdbpass> \
-e DB_DATABASE=bookstackapp \
-e APPURL=your.site.here.xyz \
-e APP_URL=https://your.site.here.xyz \
-p 6875:80 \
-v <path to data>:/config \
--restart unless-stopped \
Expand All @@ -89,7 +89,7 @@ services:
- DB_USER=<yourdbuser>
- DB_PASS=<yourdbpass>
- DB_DATABASE=bookstackapp
- APPURL=your.site.here.xyz
- APP_URL=https://your.site.here.xyz
volumes:
- <path to data>:/config
ports:
Expand All @@ -111,7 +111,7 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e DB_USER=<yourdbuser>` | for specifying the database user |
| `-e DB_PASS=<yourdbpass>` | for specifying the database password |
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
| `-e APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on |
| `-e APP_URL=https://your.site.here.xyz` | for specifying the url your application will be accessed on |
| `-v /config` | this will store any uploaded data on the docker host |

## User / Group Identifiers
Expand Down Expand Up @@ -150,14 +150,14 @@ Then docker start bookstackapp to start the container. You should then be able t

Default username is admin@admin.com with password of **password**

If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APPURL` environment variable is set, or it will not work
If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work

Documentation can be found at https://www.bookstackapp.com/docs/

### Advanced Users
If you wish to use the extra functionality of BookStack such as email, memcache, ldap and so on you will need to make your own .env file with guidance from the BookStack documentation.

When you create the container, do not set any arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
When you create the container, do not set any arguements for SQL or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit.

### Composer

Expand Down