FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.20

FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.21

ARG BUILD_DATE

echo"**** install composer dependencies ****" && \

composer install -d /app/www/ && \

printf"Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \

echo"**** create symlinks ****" && \

/bin/bash -c \

for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \

echo"**** cleanup ****" && \

rm -rf \

/tmp/* \

# syntax=docker/dockerfile:1

FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.20

FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.21

# set version label

ARG BUILD_DATE

echo "**** install composer dependencies ****" && \

composer install -d /app/www/ && \

printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \

echo "**** create symlinks ****" && \

/bin/bash -c \

'dst=(www/themes www/files www/images www/uploads backups www/framework/cache www/framework/sessions www/framework/views log/bookstack/laravel.log www/.env); \

src=(themes storage/uploads/files storage/uploads/images public/uploads storage/backup storage/framework/cache storage/framework/sessions storage/framework/views storage/logs/laravel.log .env); \

for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \

echo "**** cleanup ****" && \

rm -rf \

/tmp/* \

The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.

This image can be run with a read-only container filesystem. For details please[read the docs](https://docs.linuxserver.io/misc/read-only/).

*`/tmp` must be mounted to tmpfs

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

|`-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|

|`--read-only=true`| Run container with a read-only filesystem. Please[read the docs](https://docs.linuxserver.io/misc/read-only/).|

***17.12.24:** - Rebase to Alpine 3.21.

***11.10.24:** - Default to environment config over .env file config.

***06.09.24:** - Add php-exiffor reading image EXIF data.

***27.05.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.

opt_param_usage_include_env:true

opt_param_env_vars:

-{env_var: "QUEUE_CONNECTION", env_value: "", desc: "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)."}

readonly_supported:true

readonly_message:|

app_setup_block_enabled:true

app_setup_block:|

changelogs:

-{date: "17.12.24:", desc: "Rebase to Alpine 3.21."}

-{date: "11.10.24:", desc: "Default to environment config over .env file config."}

-{date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}

-{date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}

# create directory structure

mkdir -p \

/config/www/{uploads,files,images,themes} \

/config/www/framework/{cache,sessions,views} \

/config/backups \

/config/log/bookstack

rm -rf /config/www/framework/{cache,sessions,views}/*

# check for .env and copy default if needed

if [[ ! -f "/config/www/.env" ]] || [[ ! -s "/config/www/.env" ]]; then

cp /app/www/.env.example /config/www/.env

fi

# create symlinks

symlinks=(

/app/www/themes

/app/www/storage/uploads/files

/app/www/storage/uploads/images

/app/www/public/uploads

/app/www/.env

)

for i in "${symlinks[@]}"; do

if [[ -e "${i}" && ! -L "${i}" ]]; then

rm -rf "${i}"

fi

if [[ ! -L "${i}" ]]; then

ln -s /config/www/"$(basename "${i}")" "${i}"

fi

done

if [[ -e "/app/www/storage/backups" && ! -L "/app/www/storage/backups" ]]; then

rm -rf "/app/www/storage/backups"

fi

if [[ ! -L "/app/www/storage/backups" ]]; then

ln -s "/config/backups" "/app/www/storage/backups"

fi

if [[ -e "/app/www/storage/logs" && ! -L "/app/www/storage/logs" ]]; then

rm -rf "/app/www/storage/logs"

fi

if [[ ! -L "/app/www/storage/logs" ]]; then

ln -s "/config/log/bookstack" "/app/www/storage/logs"

fi

# Check for app key

if [[ -z ${APP_KEY} ]]; then

if ! grep -qE "APP_KEY=[0-9A-Za-z:+\/=]{1,}" /app/www/.env 2> /dev/null || grep -qE "APP_KEY=SomeRandomString" /app/www/.env 2> /dev/null; then

if ! grep -qE "APP_KEY=[0-9A-Za-z:+\/=]{1,}" /config/www/.env 2> /dev/null || grep -qE "APP_KEY=SomeRandomString" /config/www/.env 2> /dev/null; then

echo "The application key is missing, halting init!"

echo "You can generate a key with: docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey"

echo "And apply it to the APP_KEY environment variable."

END=$((SECONDS + 30))

while [[ ${SECONDS} -lt ${END} ]] && [[ -n "${DB_HOST+x}" ]]; do

if [[ $(/usr/bin/nc -w1 "${DB_HOST}" "${DB_PORT}" | tr -d '\0') ]]; then

if [[ ! -f /dbwait.lock ]]; then

if [[ ! -f /tmp/dbwait.lock ]]; then

sleep 5

fi

touch /dbwait.lock

touch /tmp/dbwait.lock

break

else

sleep 1

# permissions

lsiown -R abc:abc \

/app/www/storage \

/config