This repository will build a container image for running BookStack - A knowledge base/information manager.

• Nfrastack

• About
• Maintainer
• Table of Contents
• Installation
  • Prebuilt Images
  • Quick Start
  • Persistent Storage
  • Environment Variables
    • Base Images used
    • Core Configuration
    • Database
    • Application
    • Setting Arbitrary BookStack Keys
    • Image Optimization
    • Single Sign On Settings
    • LDAP Scheduled Sync
• Maintenance
  • Shell Access
• Support & Maintenance
• References
• License

Feature limited builds of the image are available on the Github Container Registry and Docker Hub.

To unlock advanced features, one must provide a code to be able to change specific environment variables from defaults. Support the development to gain access to a code.

To get access to the image use your container orchestrator to pull from the following locations:

ghcr.io/nfrastack/container-bookstack:(image_tag)
docker.io/nfrastack/bookstack:(image_tag)

Image tag syntax is:

<image>:<optional tag>-<optional phpversion>

Example:

docker.io/nfrastack/container-bookstack:latest or

ghcr.io/nfrastack/container-bookstack:1.0-php84

• latest will be the most recent commit

• An optional tag may exist that matches the CHANGELOG - These are the safest

Have a look at the container registries and see what tags are available.

Images are built for amd64 by default, with optional support for arm64 and other architectures.

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for your use.

• Map persistent storage for access to configuration and data files for backup.

• Set various environment variables to understand the capabilities of this image.

The first boot can take from 2 minutes - 5 minutes depending on your CPU to setup the proper schemas.

The following directories/files should be mapped for persistent storage in order to utilize the container effectively.

• Variables showing an 'x' under the Advanced column can only be set if the containers advanced functionality is enabled.

• BookStack docs: https://www.bookstackapp.com/docs/

For any other BookStack .env key (the full reference lives in /www/bookstack/.env.example.complete inside the running container), set BOOKSTACK_<KEY>=value

environment:
  - BOOKSTACK_APP_DISPLAY_TIMEZONE=America/Vancouver
  - BOOKSTACK_MAIL_VERIFY_SSL=true
  - BOOKSTACK_ALLOW_UNTRUSTED_SERVER_FETCHING=false
  - BOOKSTACK_EXPORT_PAGE_SIZE=letter
  - BOOKSTACK_APP_CONTENT_FILTERING=jfha

becomes the following lines in /www/bookstack/.env:

APP_DISPLAY_TIMEZONE=America/Vancouver
MAIL_VERIFY_SSL=true
ALLOW_UNTRUSTED_SERVER_FETCHING=false
EXPORT_PAGE_SIZE=letter
APP_CONTENT_FILTERING=jfha

Use unset, empty string or null to clear a variable defined in config

This is an out of vendor addon that schedules a routine to optimize any png or jp(e)g files that hav been uploaded at a specific time and interval to cut down on storage size.

This is an out of vendor addon that allows for logging into a BookStack instance by sending a header value to the application. The user must already exist in the user tables to allow this sort of automatic login.

When ENABLE_SSO=TRUE the image writes both keys into .env and validates that they're set.

This is an out of vendor addon that allows for synchronizing LDAP users. It relies on existing BookStack LDAP environment variables and settings however adds the following. The user must already exist in the user tables to allow this sort of automatic login.

For debugging and maintenance, bash and sh are available in the container.

• For community help, tips, and community discussions, visit the Discussions board.
• For personalized support or a support agreement, see Nfrastack Support.
• To report bugs, submit a Bug Report. Usage questions will be closed as not-a-bug.
• Feature requests are welcome, but not guaranteed. For prioritized development, consider a support agreement.
• Updates are best-effort, with priority given to active production use and support agreements.

• https://www.bookstackapp.com/docs

This project is licensed under the MIT License - see the LICENSE file for details.