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. In this step by step guide I will show you how to install Readeck on your UGREEN NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest Readeck v0.16.0 release.

💡Note: Check out my new guide on how to Install Readeck on Your Synology NAS.

• 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 UGREEN NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Add Read & Write Permissions to the Docker Folder. If you have already added the Read and Write Permissions to the Docker Folder, skip this STEP.

• STEP 4

Go to File Manager 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.

• STEP 5

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

• STEP 6

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 7

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

• STEP 8

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.

• STEP 9

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

• STEP 10

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

• STEP 11

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

• STEP 12

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

• STEP 13

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.

• STEP 14

Your Readeck Bookmark at a glance!

• STEP 15

On the left sidebar you can easily switch the theme to Dark. Follow the instructions in the image below.

Enjoy Readeck on your UGREEN NAS!

This post was updated on Wednesday / December 11th, 2024 at 3:40 PM