From 39dc24d9edef8dca0c691c2ffd20bb409db2913c Mon Sep 17 00:00:00 2001 From: <> Date: Thu, 28 Dec 2023 18:36:42 +0000 Subject: [PATCH] Deployed d99ca032 with MkDocs version: 1.5.3 --- images/docker-bookstack/index.html | 6 +++--- images/docker-changedetection.io/index.html | 6 +++--- images/docker-feed2toot/index.html | 8 ++++---- images/docker-healthchecks/index.html | 8 ++++---- images/docker-smokeping/index.html | 4 ++-- images/docker-xbackbone/index.html | 8 ++++---- search/search_index.json | 2 +- sitemap.xml.gz | Bin 1860 -> 1860 bytes 8 files changed, 21 insertions(+), 21 deletions(-) diff --git a/images/docker-bookstack/index.html b/images/docker-bookstack/index.html index 4b94431976..5dce9dbae6 100644 --- a/images/docker-bookstack/index.html +++ b/images/docker-bookstack/index.html @@ -47,10 +47,10 @@ -e DB_DATABASE=bookstackapp \ -e QUEUE_CONNECTION= `#optional` \ -p 6875:80 \ - -v /path/to/data:/config \ + -v /path/to/bookstack/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/bookstack:latest -

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
80 will map the container's port 80 to port 6875 on the host

Environment Variables (-e)

Env Function
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.
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.

Volume Mappings (-v)

Volume Function
/config this will store any uploaded data on the docker host

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
80 will map the container's port 80 to port 6875 on the host

Environment Variables (-e)

Env Function
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.
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.

Volume Mappings (-v)

Volume Function
/config Persistent config files

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
 

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user
 

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info