LiveTorrentBackend is a server that uses WebTorrent and Hono to serve torrent file content.
Originally designed as part of the Live Torrent project's backend, it can also be used independently or integrated into your own projects.
For more details check the documentation.
-
Search for torrent files using various trackers (e.g., 1337x, RARBG, EZTV, YTS).
-
List and view torrent files.
-
Serve, download, visit torrent file content.
-
Search OpenSubtitles subtitles BETA.
Coming soon: Download subtitles.
To use the Docker image, run:
docker run -d -p 3000:3000 -v $(pwd)/downloads:/app/downloads davenchy/live-torrent-backend:latest
Mount the /app/downloads
volume to manage downloaded files.
OpenAPI is used to build the documentation, which written in the openapi.yaml
file.
Start the server and visit /docs
to view the documentation.
Ensure you have Node.js version 18 installed. Then, run the following commands:
git clone --depth=1 https://github.com/Davenchy/live-torrent-backend.git
cd live-torrent-backend
npm install
npm start
Set the following environment variables, also you could user the .env
file:
Variable Name | Is Required | Default Value | Description |
---|---|---|---|
PORT | NO | 3000 | The port to listen on. |
OS_APIKEY | For OpenSubtitles API. | - | OpenSubtitles API key. |
OS_USERAGENT | For OpenSubtitles API. | - | OpenSubtitles User Agent. |
For more information about OpenSubtitles API check documentation on OpenSubtitles API.