bitmagnet on Unraid guide

This guide will explain how to setup a minimal bitmagnet environment on your Unraid OS.
The minimal setup consists of 2 containers; PostgreSQL and bitmagnet.

Minimal setup excludes the following containers from the original docker-compose.yml:

gluetun  
grafana
grafana-agent
prometheus
loki
pyroscope
postgres-exporter

There is (currently) no guide available for a full setup including any of the other containers.

Read the FAQ

UNDERSTAND WHAT bitmagnet IS, READ THE FAQ ON bitmagnet.io!
Figure out on how to pass the bitmagnet Docker container through a VPN.
I am not affliliated with any VPN provider, but I can personally recommend Windscribe.
The owner of bitmagnet recommands Mullvad, which I also recommend.

Docker Containers setup

In order to get bitmagnet up- and running on Unraid, one container from the Apps section must be adjusted, and one template must be added manually.

PostgreSQL

1. In your Unraid WebUI go to the tab Apps.
2. Search for postgresql15, you shall see an result from jj9987 titled postgresql15.
3. Press install button, and make the following changes:
   a. Make sure that Basic view is switched to Advanced view in the top right.
   b. Change the Name to something else, I named it bitmagnet-postgresql.
   c. Since PostgreSQL 16 will be used instead of 15, I changed the number in the Overview section.
   d. Change the Repository from postgres:15 to postgres:16-alpine. bitmagnet's own docker-compose.yml file uses this PostgreSQL container, hence the change.
   e. Enter the remaining fields for POSTGRES_PASSWORD, POSTGRES_USER, POSTGRES_DB and Database Storage Path. Note that bitmagnet expects the following values by default: POSTGRES_USER:postgres and POSTGRES_DB:bitmagnet.
   f. APPLY the settings to start the postgres container.

bitmagnet

Currently, there is no bitmagnet template for Unraid available. In the future it may be published to the official Apps-section in Unraid, but for now it's a bit more manual.

1. In the Unraid WebUI, open Terminal and enter the following:
   curl https://raw.githubusercontent.com/DyonR/bitmagnet-unraid/main/my-bitmagnet.xml -o /boot/config/plugins/dockerMan/templates-user/my-bitmagnet.xml
2. Go to the Docker tab and at the bottom select ADD CONTAINER.
3. At the Template -> select a template -> User Template -> bitmagnet. The template will now load in the WebUI.
4. Configure the variables to your liking, a few things to know:
   a. Post Arguments has 3 'keys' enabled, --keys=http_server, --keys=queue_server and --keys=dht_crawler, this is default. If you don't wish to run the dht_crawler, you can remove that key.
   b. Under the Show more settings ... menu (above the APPLY/DONE/SAVE button), there are advanced settings located to configure bitmagnet more to your liking.
   c. Follow this guide of Synology to obtain a TMDB API key.
   d. APPLY the settings to start the bitmagnet container.
5. Your bitmagnet container is now accessible via http://your-unraid-ip:3333/. (Unless you made changes to the network configuration but then you know what you are doing.)