bitmagnet

(โ˜… 4,306)

A self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.

  • .dockerignore
  • .editorconfig
  • .envrc
  • .gitignore
  • .golangci.yml
  • .goreleaser.yml
  • .mockery.yml
  • .prettierignore
  • ci.Dockerfile
  • CODE_OF_CONDUCT.md
  • docker-compose.yml
  • Dockerfile
  • Dockerfile_dev
  • flake.lock
  • flake.nix
  • go.mod
  • go.sum
  • goreleaser.Dockerfile
  • LICENSE
  • main.go
  • README.md
  • Taskfile.yml
  • tools.go

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/bitmagnet-io/bitmagnet

Downloads the entire project code from GitHub to your computer.

cd bitmagnet

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd webui

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

5. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
cd bitmagnet.io

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

โœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation