You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-9Lines changed: 10 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ docker create \
62
62
-e DB_USER=<yourdbuser> \
63
63
-e DB_PASS=<yourdbpass> \
64
64
-e DB_DATABASE=bookstackapp \
65
-
-e APPURL=your.site.here.xyz \
65
+
-e APP_URL=your.site.here.xyz \
66
66
-p 6875:80 \
67
67
-v <path to data>:/config \
68
68
--restart unless-stopped \
@@ -88,7 +88,7 @@ services:
88
88
- DB_USER=<yourdbuser>
89
89
- DB_PASS=<yourdbpass>
90
90
- DB_DATABASE=bookstackapp
91
-
- APPURL=your.site.here.xyz
91
+
- APP_URL=your.site.here.xyz
92
92
volumes:
93
93
- <path to data>:/config
94
94
ports:
@@ -110,7 +110,7 @@ Container images are configured using parameters passed at runtime (such as thos
110
110
|`-e DB_USER=<yourdbuser>`| for specifying the database user |
111
111
|`-e DB_PASS=<yourdbpass>`| for specifying the database password |
112
112
|`-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)|
114
114
|`-v /config`| this will store any uploaded data on the docker host |
115
115
116
116
## User / Group Identifiers
@@ -137,10 +137,11 @@ Once the MariaDB container is deployed, you can enter the following commands int
137
137
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
138
138
139
139
```
140
-
from shell: mysql -u root -p
140
+
from shell on sql container:
141
+
mysql -u root -p
141
142
CREATE DATABASE bookstackapp;
142
143
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
143
-
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@%;
144
+
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%';
144
145
FLUSH PRIVILEGES;
145
146
```
146
147
@@ -150,14 +151,14 @@ Then docker start bookstackapp to start the container. You should then be able t
150
151
151
152
Default username is admin@admin.com with password of **password**
152
153
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
154
155
155
-
Documentation can be found at https://www.bookstackapp.com/docs/
156
+
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
156
157
157
-
### Advanced Users
158
+
### Advanced Users (full control over the .env file)
158
159
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.
159
160
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.
0 commit comments