LAB-linuxserver/docker-bookstack
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-bookstack.git synced 2026-02-20 02:30:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix unhelpful default values

Browse Source
This commit is contained in:
thespad 2024-10-12 20:19:24 +01:00
parent 4cb4610150
commit 448b16865f
No known key found for this signature in database
2 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -71,6 +71,7 @@ If you intend to use this application behind a subfolder reverse proxy, such as
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
### BookStack File & Directory Paths
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
@ -85,6 +86,7 @@ Below is a mapping of container `/config` paths to those relative within a BookS
- `/config/www/uploads/` => `public/uploads/`
### 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.
@ -105,12 +107,12 @@ services:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- APP_URL=yourbaseurl
- DB_HOST=yourdbhost
- DB_PORT=yourdbport
- DB_USERNAME=yourdbuser
- DB_PASSWORD=yourdbpass
- DB_DATABASE=bookstackapp
- APP_URL=
- DB_HOST=
- DB_PORT=3306
- DB_USERNAME=
- DB_PASSWORD=
- DB_DATABASE=
- QUEUE_CONNECTION= #optional
volumes:
- /path/to/bookstack/config:/config
@ -127,12 +129,12 @@ 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_USERNAME=yourdbuser \
-e DB_PASSWORD=yourdbpass \
-e DB_DATABASE=bookstackapp \
-e APP_URL= \
-e DB_HOST= \
-e DB_PORT=3306 \
-e DB_USERNAME= \
-e DB_PASSWORD= \
-e DB_DATABASE= \
-e QUEUE_CONNECTION= `#optional` \
-p 6875:80 \
-v /path/to/bookstack/config:/config \
@ -150,12 +152,12 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e 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` |
| `-e DB_HOST=yourdbhost` | for specifying the database host |
| `-e DB_PORT=yourdbport` | for specifying the database port if not default 3306 |
| `-e DB_USERNAME=yourdbuser` | for specifying the database user |
| `-e DB_PASSWORD=yourdbpass` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
| `-e APP_URL=` | The IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
| `-e DB_HOST=` | The database instance hostname |
| `-e DB_PORT=3306` | Database port (default `3306`) |
| `-e DB_USERNAME=` | Database user |
| `-e DB_PASSWORD=` | Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
| `-e DB_DATABASE=` | Database name |
| `-e 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). |
| `-v /config` | Persistent config files |

12
readme-vars.yml
View File

@ -24,12 +24,12 @@ param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files" }
param_usage_include_env: true
param_env_vars:
- { env_var: "APP_URL", env_value: "yourbaseurl", desc: "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`"}
- { env_var: "DB_HOST", env_value: "yourdbhost", desc: "for specifying the database host" }
- { env_var: "DB_PORT", env_value: "yourdbport", desc: "for specifying the database port if not default 3306" }
- { env_var: "DB_USERNAME", env_value: "yourdbuser", desc: "for specifying the database user" }
- { env_var: "DB_PASSWORD", env_value: "yourdbpass", desc: "for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" }
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
- { env_var: "APP_URL", env_value: "", desc: "The IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
- { env_var: "DB_HOST", env_value: "", desc: "The database instance hostname" }
- { env_var: "DB_PORT", env_value: "3306", desc: "Database port (default `3306`)" }
- { env_var: "DB_USERNAME", env_value: "", desc: "Database user" }
- { env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" }
- { env_var: "DB_DATABASE", env_value: "", desc: "Database name" }
param_usage_include_ports: true
param_ports: