📚 BookStack

BookStack is a platform for storing and organising information and documentation. It provides a pleasant and simple out-of-the-box experience with an intuitive interface — only basic word-processing skills are required to get started.

🏷ïļ Category: Productivity

ðŸģ Image: lscr.io/linuxserver/bookstack:latest


   
ðŸ“Ķ Project github.com/BookStackApp/BookStack
🐛 Support GitHub Issues
💛 Donate github.com/sponsors/ssddanbrown

🌐 Ports

Port Protocol Description
6875 TCP BookStack Web Interface

ðŸ’ū Volumes

Host Path Container Path Mode Description
/mnt/cache/appdata/bookstack /config RW App Data & Config

⚙ïļ Environment Variables

🌍 General

Variable Default Masked Description
TZ Europe/Berlin ❌ Timezone
APP_URL http://192.168.1.1:6875 ❌ Full URL to your BookStack instance
APP_KEY `` ❌ Session encryption key (see below!)
QUEUE_CONNECTION database ❌ Async action handling

🗄ïļ Database

Variable Default Masked Description
DB_HOST mariadb ❌ Database Host
DB_PORT 3306 ❌ Database Port
DB_USERNAME bookstack ❌ Database Username
DB_PASSWORD bookstack ❌ Database Password
DB_DATABASE bookstack ❌ Database Name

🔑 Generating the APP_KEY

The APP_KEY is required and must be generated before starting the container! Run the following command to generate it:

docker run -it --rm --entrypoint /bin/bash \
  lscr.io/linuxserver/bookstack:latest appkey

Copy the output and paste it as the value for APP_KEY.


🚀 Quick Start

  1. Set up a MariaDB database first (required!)
  2. Generate your APP_KEY using the command above
  3. Open the MOS Hub and search for BookStack
  4. Fill in all environment variables
  5. Click Install
  6. Access BookStack at http://your-server-ip:6875
  7. Default login: admin@admin.com / password

⚠ïļ Note: BookStack requires a running MariaDB instance. Make sure the database is up and the credentials match before starting BookStack.

ðŸ’Ą Tip: Change the default admin password immediately after your first login!


MOS Templates – maintained by J000K3R

This site uses Just the Docs, a documentation theme for Jekyll.