Teedy is an open source, lightweight document management system for individuals and businesses. With Teedy, you can easily import documents from emails in the EML format. It supports image, PDF, ODT, DOCX, PPTX files and optical character recognition. Teedy has a responsive user interface and provides video file support. In this step by step guide I will show you how to install Teedy on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Teedy v1.11 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

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 4

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

• STEP 5

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

• STEP 6

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8928

• STEP 7

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.

• STEP 8

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

• STEP 9

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

• STEP 10

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

• STEP 11

Now create two new folders inside the teedydocs folder that you created at STEP 10 and name them data and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

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

• STEP 13

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

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

version: "3.9"
services:
  db:
    image: postgres:16
    container_name: Teedy-DB
    hostname: teedy-db
    mem_limit: 1g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "teedy", "-U", "teedyuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/teedydocs/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: teedy
      POSTGRES_USER: teedyuser
      POSTGRES_PASSWORD: teedypass
    restart: on-failure:5
    
  teedy-server:
    image: sismics/docs:v1.11
    container_name: Teedy
    restart: on-failure:5
    ports:
      - 8928:8080
    environment:
      DOCS_BASE_URL: https://teedydocs.yourname.synology.me
      DATABASE_URL: jdbc:postgresql://teedy-db:5432/teedy
      DATABASE_USER: teedyuser
      DATABASE_PASSWORD: teedypass
      DATABASE_POOL_SIZE: 10
      OCS_DEFAULT_LANGUAGE: eng #or fra, ita, deu, spa, por, pol, rus, ukr, ara, hin, chi_sim, chi_tra, jpn, tha, kor, nld, tur, heb, hun, fin, swe, lav, dan
    volumes:
      - /volume1/docker/teedydocs/data:/data:rw
    depends_on:
      - db

Note: Before you paste the code above in the Web editor area below, change the value for DOCS_BASE_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for OCS_DEFAULT_LANGUAGE and add your own language. eng stands for English, deu stands for German, fra stands for French etc.

• STEP 14

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.

• STEP 15

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

• STEP 16

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

• STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://teedydocs.yourname.synology.me In my case it’s https://teedydocs.mariushosting.synology.me If everything goes right, you will see the Teedy Login Page. Type in the default username and password then click Sign in. Follow the instructions in the image below.

⚠️Warning: the default username is admin and the default password is admin

• STEP 18

At the top right of the page, click admin. Follow the instructions in the image below.

• STEP 19

Change the default admin password with your own password. Click Save. Follow the instructions in the image below.

• STEP 20

Upload your documents! Follow the instructions in the image below.

Enjoy Teedy!

🆘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 Teedy 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 / March 4th, 2024 at 4:54 PM