How to Install Documize on Your Synology NAS

How to Install Documize on Your Synology NAS

Documize Community is an open source, self-hosted, modern, lightweight alternative to Confluence and other similar solutions. Built for technical and non-technical users, Documize is designed to unify both customer-facing and internal documentation. Organization is made through labels, spaces and categories. Documize is built with Golang + EmberJS and compiled down to a single executable binary that is available for Linux, Windows and Mac. In this step by step guide I will show you how to install Documize on your Synology NAS using Docker & Portainer.

Note: This guide works perfectly with the latest Documize v5.3.0 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 new folder and name it documizedb. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

1 Documize Synology NAS Set up

  • STEP 4

Visit the official documize community page then get an Activation Key. Scroll down their webpage all the way until you find the Activation Key Area. Add your own company name and your own email. Hit the purple Get Activation Key button. You will get your personalized key via email. You will need this key at STEP 10. Follow the instructions in the image below.

2 Documize Synology NAS Set up

  • 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.

1 Synology Portainer Add Stack

  • STEP 6

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

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

version: "3"
services:
  db:
    image: postgres:12
    container_name: Documize-DB
    restart: always
    ports:
      - 5444:5432
    environment:
      POSTGRES_USER: documize
      POSTGRES_PASSWORD: documize
      POSTGRES_DB: documize
    volumes:
       - /volume1/docker/documizedb:/var/lib/postgresql/data
    networks:
       - documizenet

  app:
    image: debian:latest
    container_name: Documize
    command: /bin/sh -c "apt-get -qq update && apt-get -qq install -y wget && wget https://community-downloads.s3.us-east-2.amazonaws.com/documize-community-plus-linux-amd64 && chmod 777 ./documize-community-plus-linux-amd64 && ./documize-community-plus-linux-amd64"
    depends_on:
      - db
    ports:
      - 5003:5003
    environment:
      DOCUMIZEPORT: 5003
      DOCUMIZEDB: host=db port=5432 dbname=documize user=documize password=documize sslmode=disable
      DOCUMIZEDBTYPE: postgresql
      DOCUMIZESALT: documize
      DOCUMIZELOCATION: selfhost
    networks:
      - documizenet

volumes:
  db-data:

networks:
  documizenet:

3 Documize Synology NAS Set up

  • STEP 7

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.

4 Documize Synology NAS Set up

  • STEP 8

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

5 Documize Synology NAS Set up

  • STEP 9

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

  • STEP 10

Please wait approximately 3 minutes for the installation to be completed or you will get a blank page if you try to connect too soon. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:5003 Add your own Credentials then paste the Activation key you previously got via email at STEP 4. Click COMPLETE SETUP. Follow the instructions in the image below.

6 Documize Synology NAS Set up

  • STEP 11

Enjoy your Documize! At the top right of the page click on the gear icon to access the settings page. Follow the instructions in the image below.

7 Documize Synology NAS Set up

  • STEP 12

Customize your Documize with your favorite color, your own company logo etc. Follow the instructions in the image below.

8 Documize Synology NAS Set up

  • STEP 13

If you want to run the Documize container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS. You will also need to add websocket in order to make Documize work via HTTPS.

9 Documize Synology NAS Set up

Note: Find out how to update the Documize 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 Monday / September 19th, 2022 at 12:43 AM