Skip to content

Commit 1ba731b

Browse files
rootroot
root
authored and
root
committed
Bot Updating README from template
1 parent 8aafb41 commit 1ba731b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ docker create \
6262
-e DB_USER=<yourdbuser> \
6363
-e DB_PASS=<yourdbpass> \
6464
-e DB_DATABASE=bookstackapp \
65+
-e APPURL=your.site.here.xyz \
66+
-e ADVANCED_MODE=1 \
6567
-p 6875:80 \
6668
-v <path to data>:/config \
6769
linuxserver/bookstack
@@ -86,6 +88,8 @@ services:
8688
- DB_USER=<yourdbuser>
8789
- DB_PASS=<yourdbpass>
8890
- DB_DATABASE=bookstackapp
91+
- APPURL=your.site.here.xyz
92+
- ADVANCED_MODE=1
8993
volumes:
9094
- <path to data>:/config
9195
ports:
@@ -107,6 +111,8 @@ Container images are configured using parameters passed at runtime (such as thos
107111
| `-e DB_USER=<yourdbuser>` | for specifying the database user |
108112
| `-e DB_PASS=<yourdbpass>` | for specifying the database password |
109113
| `-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 |
110116
| `-v /config` | this will store any uploaded data on the docker host |
111117

112118
## User / Group Identifiers
@@ -145,8 +151,21 @@ Then docker start bookstackapp to start the container. You should then be able t
145151

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

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+
148156
Documentation can be found at https://www.bookstackapp.com/docs/
149157

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+
150169

151170

152171
## Support Info
@@ -160,4 +179,6 @@ Documentation can be found at https://www.bookstackapp.com/docs/
160179

161180
## Versions
162181

182+
* **08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
183+
* **23.09.28:** - Updates pre-release
163184
* **02.07.18:** - Initial Release.

0 commit comments

Comments
 (0)