How to Install Wiki.js on Your Synology NAS

How to Install Wiki.js on Your Synology NAS

Wiki.js is a wiki engine running on Node.js and written in JavaScript. It is free software released under the Affero GNU General Public License. It is available as a self-hosted solution. In this step by step guide I will show you how to install Wiki.js on your Synology NAS using Docker.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Docker via Synology “Package Center”.

Install Docker Synology DSM 7

  • STEP 3

Follow my step by step guide on how to activate your synology.me DDNS on DSM 7
Follow my step by step guide on how to activate your synology.me DDNS on DSM 6.2.4
Note: If you already own a synology.me DDNS, skip this STEP.

  • STEP 4

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

Wiki.js-Synology NAS Set up 1

  • STEP 5

Now create two new folders inside the wikijs folder that you created at STEP 4 name one “config” and the other “data“. Follow the instructions in the image below.
Note: Be careful enter only lowercase, not uppercase letters.

Wiki.js-Synology NAS Set up 2

  • STEP 6

Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 3

  • STEP 7

Once you click on User-defined script a new window will open. Follow the instructions below:

  1. General: In the Task field type in “Install Wikijs“. Uncheck “Enabled” option. Select root User.
  2. Schedule: Select Run on the following date then select “Do not repeat“.
  3. Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that click OK.
docker run -d --name=wikijs \
-p 3540:3000 \
-e PUID=1026 \
-e PGID=100 \
-e TZ=Europe/Bucharest \
-v /volume1/docker/wikijs/config:/config \
-v /volume1/docker/wikijs/data:/data \
--restart always \
ghcr.io/linuxserver/wikijs

Note: Before you paste the code above in the Run command area, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)
Note
: Before you paste the code above in the Run command area, change the value for TZ (Select your current Time Zone from this list).

Wiki.js-Synology NAS Set up 4

  • STEP 8

After you click OK on STEP 7 a new warning pop up window will open. Click OK.

Wiki.js-Synology NAS Set up 5

  • STEP 9

After you click OK on STEP 8, select your “Install Wikijs” Task then click the “Run” tab. You will be asked to run Install Wikijs – click Yes. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 6

  • STEP 10

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

  • STEP 11

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:3540 Add your email and password then add “wiki” before your synology.me DDNS address. Example: https://wiki.yourname.synology.me Click Install. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 7

  • STEP 12

Wait for Finalizing your Wiki.js Installation.

Wiki.js-Synology NAS Set up 8

  • STEP 13

Go to Control Panel / Security / Certificate then click the Add tab. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 9

  • STEP 14

After you click Add on STEP 13 a new pop up window will open. Select Add a new certificate then click Next. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 10

  • STEP 15

After you click Next, select a Description for your certificate. I choose “wikijs” because I will be using this certificate for my Wiki.js container. Select Get a certificate from Let’s Encrypt then click Next. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 11

  • STEP 16

After you click Next, on the Domain name area, type in wiki.yourname.synology.me Type in your email in the Email area, then click Done. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 12

  • STEP 17

After you click Done, you will have to wait a few seconds for your new certificate to be created. If everything goes right, you will see your new certificate in the Certificate area.

Wiki.js-Synology NAS Set up 13

Note: If you fail to create a new certificate try to create a new certificate using your http://yournasip:5000 instead using the https connection.

  • STEP 18

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 14

  • STEP 19

Now click the “Create” button. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 15

  • STEP 20

After you click the Create button, the window below will open. Follow the instructions in the image below.

On General area, set the Reverse Proxy Name description: type in wikijs or the Description you have already chosen at STEP 15. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: wiki.yourname.synology.me
Port: 443

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3540

Wiki.js-Synology NAS Set up 16

  • STEP 21

Go to Control Panel / Security / Certificate / Select the certificate you have previously created at STEP 17, then click Settings. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 17

  • STEP 22

Your new certificate should be mirroring. Select your Certificate and, from the dropdown menu, select your Certificate again, then click OK. Follow the instructions in the image below.

Wiki.js-Synology NAS Set up 18

  • STEP 23

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

  • STEP 24

Now open your browser and type in your HTTPS/SSL certificate https://wiki.yourname.synology.me/login, in my case https://wiki.mariushosting.synology.me/login add your credentials that you have previously created at STEP 11 then click Log in.

Wiki.js-Synology NAS Set up 19

  • STEP 25

Start setting up your Wiki.js! Create your first home page!

Wiki.js-Synology NAS Set up 20

Choose your favorite editor!

Wiki.js-Synology NAS Set up 21

Let’s go! Enjoy your Wiki.js!

Wiki.js-Synology NAS Set up 22

  • STEP 26

Don’t forget to Enable HTTP/2

Note: Can I run Docker on my Synology NAS? See the supported models.
Note
: Find out how to update Wiki.js container with the latest image.
Note
How to Free Disk Space on Your NAS if You Run Docker.
Note
: Instead of DDNS you can also use your own domain name.

This post was updated on Sunday / June 20th, 2021 at 11:28 PM