How to Install MkDocs on Your Synology NAS

How to Install MkDocs on Your Synology NAS

Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices. In this step by step guide I will show you how to install MkDocs on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest MkDocs v9.5.27 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

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 4

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

MkDocs Synology NAS Set up 1

  • STEP 5

Now create one new folder inside the mkdocs folder that you have previously created at STEP 4 and name it docs. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

MkDocs Synology NAS Set up 2

  • STEP 6

Download (click on the blue link below) then unzip and upload all the .md files inside the documents.zip file below in the docs folder that you have previously created at STEP 5. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻documents.zip

MkDocs Synology NAS Set up 3

  • STEP 7

Download (click on the blue link below) and upload the mkdocs.yml file below in the mkdocs folder that you have previously created at STEP 4. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻mkdocs.yml

MkDocs Synology NAS Set up 4

  • STEP 8

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 9

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

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

version: '3.9'
services:
  mkdocs:
    image: squidfunk/mkdocs-material
    container_name: MkDocs
    mem_limit: 8g
    cpu_shares: 2048
    ports:
      - 8700:8000
    volumes:
      - /volume1/docker/mkdocs:/docs:rw
    stdin_open: true
    tty: true

MkDocs Synology NAS Set up 5

  • STEP 10

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.

MkDocs Synology NAS Set up 6

  • STEP 11

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

MkDocs Synology NAS Set up 7

  • STEP 12

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

  • STEP 13

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

MkDocs Synology NAS Set up 8

  • STEP 14

To modify your MkDocs manual, you need to manually edit the mkdocs.yml file at STEP 7 using Synology Text Editor. If you want to add more .md pages, you need to create them using a Markdown program like HedgeDoc or Let’s Markdown and, after that, upload these .md files with the .md extension in the docs folder at STEP 5. Note: Read the official MkDocs documentation.

Enjoy MkDocs!

🆘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 MkDocs container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make MkDocs 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 MkDocs 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 / July 1st, 2024 at 10:24 AM