Install An Otter Wiki on a Synology NAS with Docker

An Otter Wiki is a streamlined, minimalistic wiki designed to keep things simple yet powerful. Built on Python, Markdown, and Git, it’s the perfect tool for anyone looking to create and manage content effortlessly.

Why Choose An Otter Wiki?

This wiki isn’t just minimalistic; it’s packed with thoughtful features to enhance your experience:

• Sleek interface with a built-in dark mode.
• Markdown support, including tables, for smooth editing.
• Full changelogs and page history to track your content’s evolution.
• Customizable sidebar for effortless navigation.
• Secure user authentication to protect your pages.
• Page attachments and extended Markdown capabilities: tables, footnotes, fancy blocks, alerts, and mermaid diagrams.
• (Experimental) Git integration for cloning, pulling, and pushing wiki content directly.

All this, plus the charm of a cute otter logo drawn by Christy Presler (CC BY 3.0), makes it as delightful to use as it is functional.

Whether you’re starting a personal knowledge base, a collaborative team resource, or a documentation hub, An Otter Wiki is your minimalist companion.

You can find the Official site here.

---

Screenshots/Demo 🖥️

You can find the demo here.

Here are a few screenshots to give you a better sense of how it looks.

View Screenshots

---

Create Share Folder

1. Log in to your Synology NAS
   Access your Synology NAS using your web browser and enter the login credentials.

2. Open the Main Menu
   In the top-left corner, click on the Main Menu (the icon with squares).

3. Navigate to File Station
   In the Main Menu, locate and click on File Station to open the file management tool.

4. Go to the Docker Folder
   In the left sidebar of File Station, find your Docker folder or navigate to the location where you store Docker-related files (you may need to create one if it doesn’t exist).

5. Create a New Folder
   At the top of File Station, click on Create.
   Select Create Folder from the dropdown menu.
   Name the folder otterwiki. Press OK to create the folder.

Now, you have a Otterwiki folder in the Docker directory, where you can store configuration files or other relevant data for your setup.

---

Setting up Task Scheduler

1. Log in to your Synology NAS.
2. Navigate to the Main Menu and open the Control Panel.
3. Scroll down and locate Task Scheduler, then click to open it.

4. In the top menu bar, click Create, select Scheduled Task, and choose User-defined Script.

5. In the window that appears:
   • Enter a task name. This can be anything, such as the name of the app you’re installing. It doesn’t need to be specific. Otterwiki will be fine.
   • For User, select root from the dropdown menu.
6. Click on the Schedule tab at the top:
   • Select Run on the following date and leave the Start time and Repeat options at their default values.
7. Next, click the Task Settings tab:
   • Ignore the Notification section.
   • Under Run command, paste your docker run command. Double-check to ensure all file paths and parameters are correct.

Docker Run Code

docker run -d \
  --name otterwiki \
  -p 8080:80 \
  -v /volume1/docker/otterwiki:/app-data \
  redimp/otterwiki:2

Please double-check your paths. You can also change the port number if required. Remember to visit the official guide as there may be extra features you can enable. Official Guide

8. Click OK to save the task. You’ll be prompted to enter your Synology NAS password—enter it and press Submit.
9. Back in the List of tasks, locate the task you just created.
10. Select the task, then click Run from the top menu. When prompted to confirm, click OK.

Your task will now execute, setting up your Docker container. This process may take several minutes. You can now open your container by visiting:

yournasipaddress:8080. Otterwiki should now be up and running!

---

Docker Compose Code

If you’re comfortable with Docker Compose, you can use the following configuration to set up the installation for Otterwiki.

version: '3.8'

services:
  otterwiki:
    image: redimp/otterwiki:2
    container_name: otterwiki
    ports:
      - "8080:80"
    volumes:
      - /volume1/docker/otterwiki:/app-data
    restart: unless-stopped

docker-compose up -d

Thanks for reading! 🎉🤘🎶

Cheers for reading through! Let’s keep the good times rolling. 🍻💬🔥

If you enjoy the site, feel free to tip me.