Bitmagnet is a self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration. In this step by step guide I will show you how to install Bitmagnet on your Synology NAS using Docker and Portainer.

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

• STEP 4

Go to File Station and open the docker folder. Inside the bitmagnet folder, create two new folders and name them config and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

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

• STEP 6

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

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

services:
  db:
    image: postgres:17
    container_name: Bitmagnet-DB
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "bitmagnet", "-U", "postgres"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/bitmagnet/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: bitmagnet
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgrespass
    restart: on-failure:5

  bitmagnet:
    image: ghcr.io/bitmagnet-io/bitmagnet:latest
    container_name: Bitmagnet
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 3333 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    user: 1026:100
    environment:
       POSTGRES_HOST: db
       POSTGRES_PASSWORD: postgrespass
      #TMDB_API_KEY: Your_TMDB_API_KEY themoviedb.org
    volumes:
      - /volume1/docker/bitmagnet/config:/root/.config/bitmagnet:rw
    command:
      - worker
      - run
      - --all
    ports:
      - 8346:3333
    depends_on:
      db:
        condition: service_healthy
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own PUID and PGID 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.

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

• STEP 8

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

• 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:8346

Enjoy Bitmagnet!

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

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 Bitmagnet 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 Sunday / November 10th, 2024 at 4:24 PM