How to Install Readeck With PostgreSQL on Your Synology NAS

by

How to Install Readeck With PostgreSQL on Your Synology NAS

Readeck is a simple web application that lets you save the precious readable content of web pages you like and want to keep forever. See it as a bookmark manager and a read later tool. PostgreSQL has a well-constructed user management system which can handle multiple users and grant various levels of permission. SQLite is suitable for smaller databases. As the Readeck database grows, the memory requirement also gets larger while using SQLite. Performance optimization is harder when using SQLite so PostgreSQL is the solution. In this step by step guide I will show you how to install Readeck with PostgreSQL as database on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Readeck v0.13.2 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 readeck. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Readeck Synology NAS PostgreSQL and Portainer Set up 1

  • STEP 4

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

Readeck Synology NAS PostgreSQL and Portainer Set up 2

  • 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 readeck. Follow the instructions in the image below.

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

version: "3.9"
services:
  readeck:
    container_name: Readeck
    image: codeberg.org/readeck/readeck:latest
    mem_limit: 8g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    restart: on-failure:5
    ports:
      - 4522:8000
    volumes:
      - /volume1/docker/readeck/data:/readeck:rw
    environment:
     READECK_USE_X_FORWARDED: true
     READECK_DATABASE_SOURCE: postgres://readeck:readeckpass@readeck-db:5432/readeck

  readeck-db:
    image: postgres:16
    container_name: Readeck-DB
    hostname: readeck-db
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "readeck", "-U", "readeck"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/readeck/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: readeck
      POSTGRES_USER: readeck
      POSTGRES_PASSWORD: readeckpass
    restart: on-failure:5

Readeck Synology NAS PostgreSQL and Portainer Set up 3

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

Readeck Synology NAS PostgreSQL and Portainer Set up 4

  • STEP 8

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

Readeck Synology NAS PostgreSQL and Portainer Set up 5

  • STEP 9

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

  • STEP 10

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:4522 Type in your details (Username, Email address, Password), then click Create your account. Follow the instructions in the image below.

Readeck Synology NAS PostgreSQL and Portainer Set up 6

  • STEP 11

In the URL area type in your favorite website Link, then click Save link. Follow the instructions in the image below.

Readeck Synology NAS PostgreSQL and Portainer Set up 7

  • STEP 12

Wait some seconds before your website is added in the Bookmarks area, then click on it when it’s ready. Follow the instructions in the image below.

Readeck Synology NAS PostgreSQL and Portainer Set up 8

  • STEP 13

Your Readeck Bookmark at a glance!

Readeck Synology NAS PostgreSQL and Portainer Set up 9

Enjoy Readeck!

🆘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 Readeck container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Readeck work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Readeck 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 Thursday / March 28th, 2024 at 10:39 PM

🧡 I Need Your Help!