How to Install Tube Archivist on Your Synology NAS

by

How to Install TubeArchivist on Your Synology NAS

Tube Archivist is a self hosted solution to download and privately watch your favorite subscriptions and YouTube channels without any ads. With Tube Archivist you can run your self hosted YouTube media server on your Synology NAS. In this step by step guide I will show you how to install Tube Archivist on your Synology NAS using Docker.

šŸ’”Note: This guide works perfectly with the latest Tube Archivist v0.4.13 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.

TubeArchivist Synology NAS Set up 1

  • STEP 5

Now click the ā€œCreateā€ button. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 2

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

Source:
Protocol:Ā HTTPS
Hostname: tubearchivist.yourname.synology.me
Port:Ā 443

Check Enable HSTS

Destination:
Protocol:Ā HTTP
Hostname:Ā localhost
Port:Ā 8770

TubeArchivist Synology NAS Set up 3 new

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

Synology Proxy WebSocket

  • STEP 8

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

TubeArchivist Synology NAS Set up 4

  • STEP 9

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

TubeArchivist Synology NAS Set up 5

  • STEP 10

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

TubeArchivist Synology NAS Set up 6

  • STEP 11

Now create four new folders inside the tubearchivistĀ folder that you created at STEP 10Ā and name them cache, es, media, redis. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

TubeArchivist Synology NAS Set up 7

  • STEP 12

Right click on the es folder that you have previously created at STEP 11 then click Properties. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 8

  • STEP 13

Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 9

  • STEP 14

Select Everyone then click the Edit tab. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 10

  • STEP 15

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 11

  • STEP 16

After you click Done on STEP 15, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 12

  • STEP 17

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 18

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

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

services:
  es:
    image: bbilly1/tubearchivist-es:8.14.3
    container_name: TubeArchivist-ES
    hostname: tubearchivist-es
    ulimits:
      memlock:
        soft: -1
        hard: -1
    security_opt:
      - no-new-privileges:true
      - seccomp:unconfined
    healthcheck:
      test: curl -s http://tubearchivist-es:9200 >/dev/null || exit 1
    environment:
      - TZ=Europe/Bucharest
      - ELASTIC_PASSWORD=tubearchivistpass
      - ES_JAVA_OPTS=-Xms512m -Xmx512m
      - xpack.security.enabled=true
      - discovery.type=single-node
      - path.repo=/usr/share/elasticsearch/data/snapshot
    volumes:
      - /volume1/docker/tubearchivist/es:/usr/share/elasticsearch/data:rw
    restart: on-failure:5

  redis:
    image: redis/redis-stack-server
    container_name: TubeArchivist-REDIS
    hostname: tubearchivist-redis
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    user: 1026:100
    environment:
      - TZ=Europe/Bucharest
    volumes:
      - /volume1/docker/tubearchivist/redis:/data:rw
    restart: on-failure:5
    depends_on:
      es:
        condition: service_started

  tubearchivist:
    image: bbilly1/tubearchivist:latest
    container_name: TubeArchivist
    hostname: tubearchivist
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8000' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 8770:8000
    environment:
      - TZ=Europe/Bucharest
      - HOST_UID=1026
      - HOST_GID=100
      - ES_URL=http://tubearchivist-es:9200
      - REDIS_HOST=tubearchivist-redis
      - TA_HOST=tubearchivist.yourname.synology.me
      - TA_USERNAME=marius
      - TA_PASSWORD=mariushosting
      - ELASTIC_PASSWORD=tubearchivistpass
    volumes:
      - /volume1/docker/tubearchivist/media:/youtube:rw
      - /volume1/docker/tubearchivist/cache:/cache:rw
    restart: on-failure:5
    depends_on:
      es:
        condition: service_started
      redis:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value for TZ.Ā (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value numbers for HOST_UIDĀ andĀ HOST_GIDĀ with your own values. (Follow my step by step guide on how to do this.) 1026 is my personal HOST_UID value and 100 is my personal HOST_GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for TA_HOSTĀ and type in your own synology.me DDNS that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area, change the value for TA_USERNAMEĀ and add your own username. marius is an example for a username. You have to insert your own username.
Note: Before you paste the code above in the Web editor area, change the value for TA_PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own password.

TubeArchivist Synology NAS Set up 13 new 2025

  • STEP 19

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.

TubeArchivist Synology NAS Set up 14 new 2025

  • STEP 20

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

TubeArchivist Synology NAS Set up 15

  • STEP 21

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 22

Please wait approximately 2 minutes for the installation to be completed or you will get a Synology blank page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://tubearchivist.yourname.synology.me In my case it’s https://tubearchivist.mariushosting.synology.me If everything goes right, you will see the Tube Archivist Login page. Type in your own Username and Password that you have previously created at STEP 18, then click Login. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 16

  • STEP 23

Click the Channel tab, then the + icon. In the apposite area, type in your favorite YouTube channel URL, then click Subscribe. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 17 new 2025

  • STEP 24

Click the Downloads tab. Click Rescan subscriptions. Wait until all the videos in the channel are in queue and remember that this can take a few minutes before you will be able too see them. Follow the instructions in the image below.

TubeArchivist Synology NAS Set up 18 new 2025

Enjoy Tube Archivist!

šŸ†˜TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issuesĀ article.

Note: All your downloaded videos will be saved in the media folder that you have previously create at STEP 11.

Note: Find outĀ how to update the Tube Archivist containerĀ with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Can I run Docker on my Synology NAS?Ā See the supported models.
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 Friday / February 7th, 2025 at 12:04 AM

šŸ§” I Need Your Help!