CommaFeed is a free and open source feed reader which can be self hosted on a web server, like FreshRSS. It draws inspiration from Google Reader and is built using Dropwizard along with React/TypeScript. In this step by step guide I will show you how to install CommaFeed on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest CommaFeed v3.10.0 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 CommaFeed. After that, add the following instructions:

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8073

• 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 commafeed. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Now create one new folder inside the commafeed folder that you created at STEP 10 and name it 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 commafeed. Follow the instructions in the image below.

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

version: "3.9"
services:
  postgresql:
    image: postgres
    container_name: CommaFeed-DB
    restart: on-failure:5
    mem_limit: 4g
    cpu_shares: 768
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "commafeed", "-U", "commafeed"]
      timeout: 45s
      interval: 10s
      retries: 10
    environment:
      POSTGRES_USER: commafeed
      POSTGRES_PASSWORD: commafeed
      POSTGRES_DB: commafeed
    volumes:
      - /volume1/docker/commafeed/db:/var/lib/postgresql/data:rw
      
  commafeed:
    image: athou/commafeed:latest
    container_name: CommaFeed
    healthcheck:
     test: curl -f http://localhost:8082/ || exit 1
    restart: on-failure:5
    environment:
      - CF_DATABASE_DRIVERCLASS=org.postgresql.Driver
      - CF_DATABASE_URL=jdbc:postgresql://postgresql:5432/commafeed
      - CF_DATABASE_USER=commafeed
      - CF_DATABASE_PASSWORD=commafeed
    volumes:
      - /volume1/docker/commafeed:/commafeed/data:rw
    ports:
      - 8073:8082

• STEP 14

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 15

If everything goes right, you will see the following 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://commafeed.yourname.synology.me In my case it’s https://commafeed.mariushosting.synology.me If everything goes right, you will see the CommaFeed Log in page. Click Log in. Follow the instructions in the image below.

• STEP 18

Type in the default username and password, then click Log in.

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

• STEP 19

At the top right of the page click admin then Settings. Click the Profile tab to change the default admin email and password. Click Save to save the settings. Follow the instructions in the image below.

• STEP 20

Add your first feed. At the top left of the page click the + icon then type in your favorite website RSS feed link address and click Next. Follow the instructions in the image below.

• STEP 21

Click Subscribe. Follow the instructions in the image below.

• STEP 22

Your CommaFeed app at a glance!

Enjoy CommaFeed!

🆘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: Find out how to update the CommaFeed 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 / September 21st, 2023 at 2:10 AM