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
+21Lines changed: 21 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,8 @@ 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 \
66
+
-e ADVANCED_MODE=1 \
65
67
-p 6875:80 \
66
68
-v <path to data>:/config \
67
69
linuxserver/bookstack
@@ -86,6 +88,8 @@ services:
86
88
- DB_USER=<yourdbuser>
87
89
- DB_PASS=<yourdbpass>
88
90
- DB_DATABASE=bookstackapp
91
+
- APPURL=your.site.here.xyz
92
+
- ADVANCED_MODE=1
89
93
volumes:
90
94
- <path to data>:/config
91
95
ports:
@@ -107,6 +111,8 @@ Container images are configured using parameters passed at runtime (such as thos
107
111
|`-e DB_USER=<yourdbuser>`| for specifying the database user |
108
112
|`-e DB_PASS=<yourdbpass>`| for specifying the database password |
109
113
|`-e DB_DATABASE=bookstackapp`| for specifying the database to be used |
114
+
|`-e APPURL=your.site.here.xyz`| for specifying the url your application will be accessed on |
115
+
|`-e ADVANCED_MODE=1`| enables advanced mode for direct editing of the .env - scroll down for details on this |
110
116
|`-v /config`| this will store any uploaded data on the docker host |
111
117
112
118
## User / Group Identifiers
@@ -145,8 +151,21 @@ Then docker start bookstackapp to start the container. You should then be able t
145
151
146
152
Default username is admin@admin.com with password of **password**
147
153
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 `APPURL` environment variable is set, or it will not work
155
+
148
156
Documentation can be found at https://www.bookstackapp.com/docs/
149
157
158
+
### Advanced Mode
159
+
We have implemented a special 'advanced mode' where users who wish to leverage the built in SMTP or LDAP functionality, will have the ability to edit the .env by hand. With `ADVANCED_MODE=1` set when
160
+
the container is created, it will copy the .env.example to /config within the container. You can then edit this file on the host system (make sure you read the BookStack docs) and restart the
161
+
container when finished. When the container starts, it copies /config/.env to /var/www/html/.env within the container for the web app to use. It will do this every time the container restarts.
162
+
163
+
Note, the APP_KEY is still set by PHP environment so you do not need to worrry about this.
164
+
165
+
### Composer
166
+
167
+
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
168
+
150
169
151
170
152
171
## Support Info
@@ -160,4 +179,6 @@ Documentation can be found at https://www.bookstackapp.com/docs/
160
179
161
180
## Versions
162
181
182
+
***08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
0 commit comments