Skip to content

Commit 9259e9b

Browse files
Bot Updating Templated Files
1 parent 97b1327 commit 9259e9b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ docker create \
6262
-e DB_USER=<yourdbuser> \
6363
-e DB_PASS=<yourdbpass> \
6464
-e DB_DATABASE=bookstackapp \
65-
-e APPURL=your.site.here.xyz \
65+
-e APP_URL=your.site.here.xyz \
6666
-p 6875:80 \
6767
-v <path to data>:/config \
6868
--restart unless-stopped \
@@ -88,7 +88,7 @@ services:
8888
- DB_USER=<yourdbuser>
8989
- DB_PASS=<yourdbpass>
9090
- DB_DATABASE=bookstackapp
91-
- APPURL=your.site.here.xyz
91+
- APP_URL=your.site.here.xyz
9292
volumes:
9393
- <path to data>:/config
9494
ports:
@@ -110,7 +110,7 @@ Container images are configured using parameters passed at runtime (such as thos
110110
| `-e DB_USER=<yourdbuser>` | for specifying the database user |
111111
| `-e DB_PASS=<yourdbpass>` | for specifying the database password |
112112
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
113-
| `-e APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on |
113+
| `-e APP_URL=your.site.here.xyz` | for specifying the url your application will be accessed on (required for correct operation of reverse proxy) |
114114
| `-v /config` | this will store any uploaded data on the docker host |
115115

116116
## User / Group Identifiers
@@ -137,10 +137,11 @@ Once the MariaDB container is deployed, you can enter the following commands int
137137
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
138138

139139
```
140-
from shell: mysql -u root -p
140+
from shell on sql container:
141+
mysql -u root -p
141142
CREATE DATABASE bookstackapp;
142143
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
143-
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@%;
144+
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%';
144145
FLUSH PRIVILEGES;
145146
```
146147

@@ -150,14 +151,14 @@ Then docker start bookstackapp to start the container. You should then be able t
150151

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

153-
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
154+
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
154155

155-
Documentation can be found at https://www.bookstackapp.com/docs/
156+
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
156157

157-
### Advanced Users
158+
### Advanced Users (full control over the .env file)
158159
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.
159160

160-
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.
161+
When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit.
161162

162163
### Composer
163164

0 commit comments

Comments
 (0)