https://github.com/boypt/simple-torrent
☁️ Simple Torrent: a self-hosted remote torrent client (rebranded from Cloud Torrent)
https://github.com/boypt/simple-torrent
Last synced: 9 months ago
JSON representation
☁️ Simple Torrent: a self-hosted remote torrent client (rebranded from Cloud Torrent)
- Host: GitHub
- URL: https://github.com/boypt/simple-torrent
- Owner: boypt
- License: agpl-3.0
- Archived: true
- Fork: true (jpillora/cloud-torrent)
- Created: 2018-12-17T08:12:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-28T06:24:54.000Z (almost 2 years ago)
- Last Synced: 2024-09-26T22:22:09.347Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 22.6 MB
- Stars: 1,004
- Watchers: 26
- Forks: 314
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-debrid - Simple Torrent - Go — self-hosted remote torrent client. Mobile-friendly web UI. RSS. Available on Umbrel/YunoHost. (Debrid Services / Self-Hosted Cloud Torrent)
README
**SimpleTorrent** is a a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP.
This project is a re-branded fork of [cloud-torrent](https://github.com/jpillora/cloud-torrent) by `jpillora`.
# Features
* Individual file download control (1.1.3+)
* Run external program on tasks completion: `DoneCmd`
* Stops task when seeding ratio reached: `SeedRatio`
* Download/Upload speed limiter: `UploadRate`/`DownloadRate`
* Detailed transfer stats in web UI.
* [Torrent Watcher](https://github.com/boypt/simple-torrent/wiki/Torrent-Watcher)
* K8s/docker health-check endpoint `/healthz`
* Extra trackers from external source
* Protocol Handler to `magnet:`
* Magnet RSS subscribing supported
* Flexible config file accepts multiple formats (.json/.yaml/.toml) ([by spf13/Viper](https://github.com/spf13/viper/)) (1.2.0+)
Also:
* Single binary
* Cross platform
* Embedded torrent search
* Real-time updates
* Mobile-friendly
* Fast [content server](http://golang.org/pkg/net/http/#ServeContent)
* IPv6 out of the box
* Updated torrent engine from [anacrolix/torrent](https://github.com/anacrolix/torrent)
# Install
## Binary
See [the latest release](https://github.com/boypt/cloud-torrent/releases/latest) or use the oneline script to do a quick install on a modern Linux machines.
``` bash
bash <(wget -qO- https://git.io/simpletorrentqs)
```
The script installs a systemd unit (under `scripts/cloud-torrent.service`) as service. Read further intructions: [Auth And Security](https://github.com/boypt/simple-torrent/wiki/AuthSecurity)
If hope to specify a version, just append the version number to the command.
``` bash
bash <(wget -qO- https://git.io/simpletorrentqs) 1.3.3
```
## Docker [][dockerhub]
[dockerhub]: https://hub.docker.com/r/boypt/cloud-torrent/
``` bash
$ docker run -d -p 3000:3000 -v /path/to/my/downloads:/downloads -v /path/to/my/torrents:/torrents boypt/cloud-torrent
```
When running as a container, keep in mind:
* You need also to expose your torrent incoming port (50007 by default) if you want to seed (`-p 50007:50007`). Also, you'll have to forward the port on your router.
* Automatic port forwarding on your router via UPnP IGD will not work unless run in `host` mode (`--net=host`).
It's more practical to run docker-compose, see Wiki Page: [DockerCompose](https://github.com/boypt/simple-torrent/wiki/DockerCompose)
## Source
**Requirement**
- Latest [Golang](https://golang.org/dl/) (Go 1.16+)
``` sh
$ git clone https://github.com/boypt/simple-torrent.git
$ cd simple-torrent
$ ./scripts/make_release.sh
```
# Usage
## Commandline Options
See Wiki [Command line Options](https://github.com/boypt/simple-torrent/wiki/Command-line-Options)
## Configuration file
See Wiki [Config File](https://github.com/boypt/simple-torrent/wiki/Config-File)
## Use with WEB servers (nginx/caddy)
See Wiki [Behind WebServer (reverse proxying)](https://github.com/boypt/simple-torrent/wiki/ReverseProxy)
# Credits
* Credits to @jpillora for [Cloud Torrent](https://github.com/jpillora/cloud-torrent).
* Credits to @anacrolix for https://github.com/anacrolix/torrent