linuxserver/bookstack¶
Bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/bookstack:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The default username is admin@admin.com with the password of password, access the container at http://dockerhost:6875.
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the APP_URL environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
BookStack File & Directory Paths¶
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the /config folder so that they are persistent & accessible when the /config container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container /config paths to those relative within a BookStack install directory:
- /config container path => BookStack relative path
/config/www/.env=>.env/config/www/laravel.log=>storage/logs/laravel.log/config/www/backups/=>storage/backups//config/www/files/=>storage/uploads/files//config/www/images/=>storage/uploads/images//config/www/themes/=>themes//config/www/uploads/=>public/uploads/
Advanced Users (full control over the .env file)¶
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
---
+ bookstack - LinuxServer.io linuxserver/bookstack¶
Bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/bookstack:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The default username is admin@admin.com with the password of password, access the container at http://dockerhost:6875.
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the APP_URL environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
BookStack File & Directory Paths¶
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the /config folder so that they are persistent & accessible when the /config container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container /config paths to those relative within a BookStack install directory:
- /config container path => BookStack relative path
/config/www/.env => .env/config/www/laravel.log => storage/logs/laravel.log/config/www/backups/ => storage/backups//config/www/files/ => storage/uploads/files//config/www/images/ => storage/uploads/images//config/www/themes/ => themes//config/www/uploads/ => public/uploads/
Advanced Users (full control over the .env file)¶
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
---
version: "2"
services:
bookstack:
@@ -73,4 +73,4 @@
--pull \
-t lscr.io/linuxserver/bookstack:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 25.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
- 23.12.23: - Rebase to Alpine 3.19 with php 8.3.
- 31.10.23: - Further sanitize sed replace.
- 07.06.23: - Add mariadb-client for bookstack-system-cli support.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 01.03.23: - Add php iconv.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Wrap
.env values in quotes. - 05.01.23: - Fix db password setting (sed escape
&). - 21.12.22: - Update db info in .env file when env vars are updated.
- 10.10.22: - Remove password escape logic which caused problems for a small subset of users.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.03.22: - Add symlinks for theme support.
- 11.07.21: - Rebase to Alpine 3.14.
- 12.01.21: - Remove unused requirement, as of release 0.31.0.
- 17.12.20: - Make APP_URL var required (upstream changes).
- 17.09.20: - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.
- 19.12.19: - Rebasing to alpine 3.11.
- 26.07.19: - Use old version of tidyhtml pending upstream fixes.
- 28.06.19: - Rebasing to alpine 3.10.
- 14.06.19: - Add wkhtmltopdf to image for PDF rendering.
- 20.04.19: - Rebase to Alpine 3.9, add MySQL init logic.
- 22.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.01.19: - Added php7-curl
- 04.11.18: - Added php7-ldap
- 15.10.18: - Changed functionality for advanced users
- 08.10.18: - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
- 23.09.28: - Updates pre-release
- 02.07.18: - Initial Release.
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 25.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
- 23.12.23: - Rebase to Alpine 3.19 with php 8.3.
- 31.10.23: - Further sanitize sed replace.
- 07.06.23: - Add mariadb-client for bookstack-system-cli support.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 01.03.23: - Add php iconv.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Wrap
.envvalues in quotes. - 05.01.23: - Fix db password setting (sed escape
&). - 21.12.22: - Update db info in .env file when env vars are updated.
- 10.10.22: - Remove password escape logic which caused problems for a small subset of users.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.03.22: - Add symlinks for theme support.
- 11.07.21: - Rebase to Alpine 3.14.
- 12.01.21: - Remove unused requirement, as of release 0.31.0.
- 17.12.20: - Make APP_URL var required (upstream changes).
- 17.09.20: - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.
- 19.12.19: - Rebasing to alpine 3.11.
- 26.07.19: - Use old version of tidyhtml pending upstream fixes.
- 28.06.19: - Rebasing to alpine 3.10.
- 14.06.19: - Add wkhtmltopdf to image for PDF rendering.
- 20.04.19: - Rebase to Alpine 3.9, add MySQL init logic.
- 22.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.01.19: - Added php7-curl
- 04.11.18: - Added php7-ldap
- 15.10.18: - Changed functionality for advanced users
- 08.10.18: - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
- 23.09.28: - Updates pre-release
- 02.07.18: - Initial Release.
