ð 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
ð Links
| Â | Â |
|---|---|
| ðĶ 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
- Set up a MariaDB database first (required!)
- Generate your
APP_KEYusing the command above - Open the MOS Hub and search for BookStack
- Fill in all environment variables
- Click Install
- Access BookStack at
http://your-server-ip:6875 - 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!