From now on you can become the author of your own book! 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. Bookstack is a great alternative to DokuWiki that can be used for storing and organizing information and documentation. In this step by step guide I will show you how to install BookStack on your Synology NAS using Docker & Portainer.
STEP 1
Please Support My Work by Making a Donation.
STEP 2
Install Docker via Synology “Package Center”.
STEP 3
Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.
STEP 4
Go to File Station and open the docker folder. Inside the docker folder, create two new folders and name them bookstack and bookstackdb. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 5
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.
STEP 6
In the Name field type in Bookstack. Follow the instructions in the image below.
version: "2"
services:
bookstack:
image: ghcr.io/linuxserver/bookstack
container_name: Bookstack
environment:
- PUID=1026
- PGID=100
- APP_URL=http://YourNASIP:6875
- DB_HOST=bookstack_db
- DB_USER=bookstack
- DB_PASS=yourdbpass
- DB_DATABASE=bookstackapp
volumes:
- /volume1/docker/bookstack:/config
ports:
- 6875:80
restart: always
depends_on:
- bookstack_db
bookstack_db:
image: ghcr.io/linuxserver/mariadb
container_name: Bookstack-DB
environment:
- PUID=1026
- PGID=100
- TZ=Europe/Bucharest
- MYSQL_ROOT_PASSWORD=yourdbpass
- MYSQL_DATABASE=bookstackapp
- MYSQL_USER=bookstack
- MYSQL_PASSWORD=yourdbpass
volumes:
- /volume1/docker/bookstackdb:/config
restart: always
Note: After you paste the code in the Web editor, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)
Note: After you paste the code in the Web editor, change the value for TZ. (Select your current Time Zone from this list.)
Note: After you paste the code in the Web editor, change the value for APP_URL with your NAS local IP http://yourNASIP followed by :6875
Note: In the screenshot below http://192.168.1.18 is my own NAS local IP; you have to use your own NAS local IP.
STEP 7
Scroll down on the page until you see a button called Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.
STEP 8
If everything goes right, you will see this message at the top right of your screen: “Success Stack successfully deployed“.
STEP 9
Go back to STEP 1 or you will deal with karma 🙂
STEP 10
The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:6875 Type in the default Email and Password, then click LOG IN.
STEP 11
Edit your profile and change the default email, password, avatar etc. Follow the instructions in the images below.
After that, click SAVE.
STEP 12
You can now start writing your book! You can also activate the Dark Mode option.
STEP 13
STEP 14
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then bookstack. Follow the instructions in the image below.
STEP 15
After you click on bookstack stack at STEP 14, click the Editor tab and, in the APP_URL section, type in https://bookstack.yourname.synology.me Follow the instructions in the image below. Change yourname with the Synology DDNS name you have chosen at STEP 13. Follow the instructions in the image below.
STEP 16
Scroll down on the page until you see a button called Update the stack. Click on it. Follow the instructions in the image below.
STEP 17
After you click Update the stack at STEP 16, confirm by clicking Update. Follow the instructions in the image below.
STEP 17
If everything goes right, you will see this message at the top right of your screen: “Success Stack successfully deployed“.
STEP 18
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
STEP 19
Now click the “Create” button. Follow the instructions in the image below.
STEP 20
After you click the Create button, the window below will open. Follow the instructions in the image below.
On the General area, set the Reverse Proxy Name description: type in Bookstack. After that, add the following instructions:
Source:
Protocol: HTTPS
Hostname: bookstack.yourname.synology.me
Port: 443
Destination:
Protocol: HTTP
Hostname: localhost
Port: 6875
Enjoy your BookStack in HTTPS!
Note: Find out how to update the Bookstack container with the latest image.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
This post was updated on Thursday / December 8th, 2022 at 12:48 PM