WikiDocs is an Open Source, databaseless, markdown, flat-file wiki engine. It’s designed to be simple yet powerful, making it a great tool for creating and managing wikis without the complexity of a database. In this step by step guide I will show you how to install WikiDocs on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest WikiDocs v1.0.65 release.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

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 3

Go to File Station and open the docker folder. Inside the docker folder, create one folder and name it wikidocs. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 4

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 5

In the Name field type in wikidocs. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  wikidocs:
    image: zavy86/wikidocs:latest
    container_name: WikiDocs
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 80 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
       PUID: 1026
       PGID: 100
    ports:
      - 6432:80
    volumes:
      - /volume1/docker/wikidocs:/datasets:rw
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)

• STEP 6

Scroll down on the page until you see a button named 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 7

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 8

Go back to STEP 1 or you will deal with karma 🙂

• STEP 9

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:6432 Click Continue. Follow the instructions in the image below.

• STEP 10

Type in your own details, then click Continue. Follow the instructions in the image below.

• STEP 11

Click Continue. Follow the instructions in the image below.

• STEP 12

Click Continue. Follow the instructions in the image below.

• STEP 13

At the top right of the page, click the lock login icon. Follow the instructions in the image below.

• STEP 14

Type in your own password (authentication code) that you have previously added at STEP 10. Click SUBMIT. Follow the instructions in the image below.

• STEP 15

Once you are logged in, click on the settings icon at the top right of the page. Follow the instructions in the image below.

• STEP 16

You can easily change your theme to dark or change other settings. Click SAVE to save the settings. Follow the instructions in the image below.

• STEP 17

Create your first document!

Enjoy WikiDocs!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the WikiDocs container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make WikiDocs work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the WikiDocs container with the latest image.
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.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Wednesday / November 20th, 2024 at 10:01 PM