How to Install Wiki-Go on Your Synology NAS

How to Install Wiki-Go on Your Synology NAS

Wiki-Go is a lightweight, databaseless wiki platform built with Go, perfect for simple yet powerful knowledge management. It supports Markdown, full-text search, Mermaid diagrams, user permissions, and media embedding. With a flat-file structure, it’s easy to deploy via Docker, offers a RESTful API, and includes features like version history and a comments system, ideal for personal or team wikis. In this step by step guide I will show you how to install Wiki-GoĀ on your Synology NAS using Docker & Portainer.

šŸ’”Note:Ā This guide works perfectly with the latest Wiki-Go v1.3.16Ā release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Text Editor via Synology ā€œPackage Centerā€. (Mandatory STEP.) If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • 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

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

  • STEP 5

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

Wiki-Go Synology NAS Set up 1

  • STEP 6

Now click the ā€œCreateā€ button. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 2

  • STEP 7

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 Wiki-Go. After that, add the following instructions:

Source:
Protocol:Ā HTTPS
Hostname: wikigo.yourname.synology.me
Port:Ā 443

Check Enable HSTS

Destination:
Protocol:Ā HTTP
Hostname: localhost
Port:Ā 3035

Wiki-Go Synology NAS Set up 3

  • STEP 8

On the Reverse Proxy Rules click the Custom HeaderĀ tab. ClickĀ CreateĀ and then, from the drop-down menu, clickĀ WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. ClickĀ Save. Follow the instructions in the image below.

Synology Proxy WebSocket

  • STEP 9

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 4

  • STEP 10

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP CompressionĀ then click Apply. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 5

  • STEP 11

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

Wiki-Go Synology NAS Set up 6

  • STEP 12

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.

1 Synology Portainer Add Stack

  • STEP 13

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

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

services:
  wiki-go:
    image: leomoonstudios/wiki-go:latest
    container_name: Wiki-Go
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8080' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 3035:8080
    volumes:
      - /volume1/docker/wikigo:/wiki/data:rw
    environment:
       PUID: 1026
       PGID: 100
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
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.)

Wiki-Go Synology NAS Set up 7

  • STEP 14

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.

Wiki-Go Synology NAS Set up 8

  • STEP 15

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

Wiki-Go Synology NAS Set up 9

  • STEP 16

🟢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. I’ve been very honest about this aspect of my work since the beginning: I don’t run any ADS, I don’t require subscriptions, paid or otherwise, I don’t collect IPs, emails, and I don’t have any referral links from Amazon or other merchants. I also don’t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. It’s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://wikigo.yourname.synology.me In my case it’s https://wikigo.mariushosting.synology.me If everything goes right, you will see the Wiki-Go main page. On the left sidebar, switch the theme to Dark. Click Login. Type in the default Username and Password, then click Login. Follow the instructions in the image below.

āš ļøWarning: the default Username is adminĀ and the default Password is admin

Wiki-Go Synology NAS Set up 10

  • STEP 18

Click the Settings tab, then Users. Change the default Password for the admin user, then click Update User. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 11

  • STEP 19

Click the Edit tab to personalize your Wiki-Go homepage. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 12

  • STEP 20

Click Save to save your documents. Follow the instructions in the image below.

Wiki-Go Synology NAS Set up 13

  • STEP 21

If you want to modify some settings on your Wiki-Go app, go to File Station / Docker / wikigo folder, then open the config.yaml file. Follow the instructions in the image below. āš ļøWarning: To open the config.yaml file, you need to install the Synology Text Editor package as per the instructions at STEP 2.

Wiki-Go Synology NAS Set up 14

Enjoy Wiki-Go!

šŸ†˜TROUBLESHOOTING

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

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 Wiki-Go 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 Monday / April 28th, 2025 at 12:02 AM