Bot Updating Documentation

pull/142/head
LinuxServer-CI 2023-09-04 11:03:33 +00:00
rodzic a399b0ee1f
commit 6be8089c37
1 zmienionych plików z 13 dodań i 11 usunięć

Wyświetl plik

@ -64,7 +64,7 @@ Below is a mapping of container `/config` paths to those relative within a BookS
### Advanced Users (full control over the .env file)
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 arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
## Usage
@ -121,12 +121,13 @@ docker run -d \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e APP_URL=<yourbaseurl> \
-e DB_HOST=<yourdbhost> \
-e DB_PORT=<yourdbport> \
-e DB_USER=<yourdbuser> \
-e DB_PASS=<yourdbpass> \
-e APP_URL=yourbaseurl \
-e DB_HOST=yourdbhost \
-e DB_PORT=yourdbport \
-e DB_USER=yourdbuser \
-e DB_PASS=yourdbpass \
-e DB_DATABASE=bookstackapp \
-e QUEUE_CONNECTION= `#optional` \
-p 6875:80 \
-v /path/to/data:/config \
--restart unless-stopped \
@ -151,12 +152,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `APP_URL=<yourbaseurl>` | for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
| `DB_HOST=<yourdbhost>` | for specifying the database host |
| `DB_PORT=<yourdbport>` | for specifying the database port if not default 3306 |
| `DB_USER=<yourdbuser>` | for specifying the database user |
| `DB_PASS=<yourdbpass>` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
| `APP_URL=yourbaseurl` | for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
| `DB_HOST=yourdbhost` | for specifying the database host |
| `DB_PORT=yourdbport` | for specifying the database port if not default 3306 |
| `DB_USER=yourdbuser` | for specifying the database user |
| `DB_PASS=yourdbpass` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
| `DB_DATABASE=bookstackapp` | for specifying the database to be used |
| `QUEUE_CONNECTION=` | Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling). |
### Volume Mappings (`-v`)