binhex-bitmagnet
Docker app from Binhex's Repository
A self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.
Overview
Readme
View on GitHubApplication
Description
A self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.
Build notes
Latest GitHub release.
Usage
docker run -d \
--name=<container name> \
-p <webui port>:3333 \
-p <bittorrent port tcp>:3344 \
-p <bittorrent port udp>:3344/udp \
-p <postgres port>:5432 \
-v <path for config files>:/config \
-v /etc/localtime:/etc/localtime:ro \
-e TMDB_API_KEY=<tmdb key> \
-e PROCESSOR_CONCURRENCY=<int> \
-e POSTGRES_VACUUM_DB=<true|false> \
-e POSTGRES_REINDEX_DB=<true|false> \
-e ENABLE_STARTUP_SCRIPTS=<yes|no> \
-e STARTUP_SCRIPTS_MODE=<wait|parallel> \
-e HEALTHCHECK_COMMAND=<command> \
-e HEALTHCHECK_ACTION=<action> \
-e HEALTHCHECK_HOSTNAME=<hostname> \
-e UMASK=<umask for created files> \
-e PUID=<uid for user> \
-e PGID=<gid for user> \
binhex/arch-bitmagnet
Please replace all user variables in the above command defined by <> with the correct values.
Access application
http://<host ip>:3333
Example
docker run -d \
--name=bitmagnet \
-p 3333:3333 \
-p 3344:3344 \
-p 3344:3344/udp \
-p 5432:5432 \
-v /apps/docker/bitmagnet:/config \
-v /etc/localtime:/etc/localtime:ro \
-e ENABLE_STARTUP_SCRIPTS=no \
-e STARTUP_SCRIPTS_MODE=wait \
-e UMASK=000 \
-e PUID=0 \
-e PGID=0 \
binhex/arch-bitmagnet
Notes
ENABLE_STARTUP_SCRIPTS when set to yes (default no) will allow a user to
install additional packages from the official Arch Repository or the Arch User
Repository (AUR) via scripts located in the folder /config/bitmagnet/scripts/.
STARTUP_SCRIPTS_MODE controls how those scripts are executed, set to wait
(default) to run each script in turn and wait for it to complete before the next
script runs, or parallel to run all scripts at the same time.
User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-
id <username>
If you appreciate my work, then please consider buying me a beer :D
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allLinks
Details
ghcr.io/binhex/arch-bitmagnetRuntime arguments
- Web UI
http://[IP]:[PORT:3333]- Network
bridge- Shell
bash- Privileged
- false
- Extra Params
--restart=unless-stopped
Template configuration
This is the Web UI port for the application.
- Target
- 3333
- Default
- 3333
This is the bittorrent TCP port used by the application.
- Target
- 3344
- Default
- 3344
This is the bittorrent UDP port used by the application.
- Target
- 3344
- Default
- 3344
This is the port for Postgres, this is optional.
- Target
- 5432
- Default
- 5432
This is the container path to your configuration files, e.g. databases, configuration files, logs etc.
- Target
- /config
- Default
- /mnt/user/appdata/bitmagnet
Enable or disable automatic database backup on container start.
- Target
- POSTGRES_BACKUP_DB
- Default
- false|true
Number of days to retain database backups. Older backups will be automatically deleted.
- Target
- POSTGRES_BACKUP_RETENTION_DAYS
- Default
- 7
Enable or disable scheduled database backups.
- Target
- POSTGRES_SCHEDULED_BACKUP
- Default
- false|true
Interval in hours between scheduled database backups.
- Target
- POSTGRES_SCHEDULED_BACKUP_INTERVAL_HOURS
- Default
- 48
Enable or disable database restore on container start. This will drop and recreate the database.
- Target
- POSTGRES_RESTORE_DB
- Default
- false|true
Path to backup directory to restore from, e.g. '/config/bitmagnet/backups/bitmagnet_20251218_174202'. If not specified, the latest backup will be used.
- Target
- POSTGRES_RESTORE_PATH
Enable or disable database vacuuming for BitMagnet.
- Target
- POSTGRES_VACUUM_DB
- Default
- false|true
Enable or disable database reindexing for BitMagnet.
- Target
- POSTGRES_REINDEX_DB
- Default
- false|true
Specify your TMDB API key, if you do not specify your own key then a default key will be used which may result in slower indexing due to rate limiting.
- Target
- TMDB_API_KEY
Defines the maximum number of torrents to be processed/classified simultaneously. The default setting of 1 aims to support the widest range of systems. Increasing the setting (for example to 3) may improve throughput of the processor queue but is known to cause slowdowns on less powerful systems.
- Target
- PROCESSOR_CONCURRENCY
- Default
- 1
Specify whether to run startup scripts to install and/or configure additional applications.
- Target
- ENABLE_STARTUP_SCRIPTS
- Default
- no|yes
Specify whether to run the startup scripts sequentially, waiting for each script to complete, or in parallel.
- Target
- STARTUP_SCRIPTS_MODE
- Default
- wait|parallel
Enable or disable healthchecks.
- Target
- ENABLE_HEALTHCHECK
- Default
- yes|no
The command or script to execute, if not specified then the script healthcheck.sh will be used (process, dns and https checking).
- Target
- HEALTHCHECK_COMMAND
The action to execute if the healthcheck command returns a non zero exit code, if not specified the action will be 'exit 1', if you want the container to exit on failure then set the action to 'kill 1'.
- Target
- HEALTHCHECK_ACTION
The hostname used when performing HTTPS and DNS healthchecking.
- Target
- HEALTHCHECK_HOSTNAME
- Default
- google.com
User ID for the running container
- Target
- PUID
- Default
- 99
Group ID for the running container
- Target
- PGID
- Default
- 100
UMASK for the running container
- Target
- UMASK
- Default
- 000