Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anacrolix/confluence
Torrent client as a HTTP service
https://github.com/anacrolix/confluence
bittorrent go http microservice proxy service streaming torrent torrent-client
Last synced: about 1 month ago
JSON representation
Torrent client as a HTTP service
- Host: GitHub
- URL: https://github.com/anacrolix/confluence
- Owner: anacrolix
- License: mpl-2.0
- Created: 2016-12-15T06:53:35.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T05:17:35.000Z (5 months ago)
- Last Synced: 2024-08-01T22:43:50.143Z (4 months ago)
- Topics: bittorrent, go, http, microservice, proxy, service, streaming, torrent, torrent-client
- Language: Go
- Homepage:
- Size: 812 KB
- Stars: 231
- Watchers: 8
- Forks: 32
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - anacrolix/confluence - Torrent client as a HTTP service (Go)
- awesome-list-microservice - confluence
README
confluence
==========
Confluence is a torrent client as a HTTP service. This allows for easy use from other processes, languages, and machines, due to the ubiquity of HTTP. It makes use of [anacrolix/torrent](https://github.com/anacrolix/torrent)'s [download-on-demand](https://godoc.org/github.com/anacrolix/torrent#Torrent.NewReader) torrenting, and [custom data backend](https://godoc.org/github.com/anacrolix/torrent/storage#ClientImpl) features to store data in a cache. You can then utilize the BitTorrent network with sensible defaults as though it were just regular HTTP.
Installation
============
## Binary
```
go install github.com/anacrolix/confluence@latest
```
## Module
```
go get github.com/anacrolix/confluence
```
## Android
See https://github.com/arranlomas/Android-Confluence-Wrapper and https://github.com/arranlomas/confluence.
Usage
=====
```
$ godo github.com/anacrolix/confluence -h
Usage:
confluence [OPTIONS...]
Options:
-addr (string) HTTP listen address (Default: localhost:8080)
-cacheCapacity (tagflag.Bytes) Data cache capacity (Default: 11 GB)
-collectCamouflageData (bool)
-debugOnMain (bool) Expose default serve mux /debug/ endpoints over http
-dht (bool) Default: true
-disableTrackers (bool) Disables all trackers
-fileDir (string) File-based storage directory, overrides piece storage
-implicitTracker ([]string) Trackers to be used for all torrents
-overrideTrackers (bool) Only use implied trackers
-pex (bool) Default: true
-publicIp4 (net.IP) Public IPv4 address
-publicIp6 (net.IP) Public IPv6 address
-seed (bool) Seed data
-sqliteStorage (*string)
-tcpPeers (bool) Allow TCP peers (Default: true)
-torrentGrace (time.Duration) How long to wait to drop a torrent after its last request (Default: 1m0s)
-uPnPPortForwarding (bool) Port forward via UPnP
-unlimitedCache (bool) Don't limit cache capacity
-utpPeers (bool) Allow uTP peers (Default: true)
```
Confluence will announce itself to DHT, and wait for HTTP activity. Torrents are added to the client as needed. Without an active request on a torrent, it is kicked from the client after the torrent grace period. Its data however may remain in the cache for future uses of that torrent.
Routes
======
There are several routes to interact with torrents:
- `GET /data?ih=&path=&filename=`,
or `GET /data/infohash//`:
Responds with file or whole-torrent data, depending on presence of file name argument.
Note that this handler supports HTTP range requests for bytes. Response blocks until the data is available.
- `GET /status`. This fetches the textual status info page per anacrolix/torrent.Client.WriteStatus. Very useful for debugging.
- `GET /info?ih=`. This returns the info bytes for the matching torrent. It's useful if the caller needs to know about the torrent, such as what files it contains. It will block until the info is available. The response is the full bencoded info dictionary per [BEP 3](http://www.bittorrent.org/beps/bep_0003.html).
- `/events?ih=`. This is a websocket that emits frames with [confluence.Event] encoded as JSON for the torrent. The PieceChanged field for instance is set if the given piece changed [state](https://godoc.org/github.com/anacrolix/torrent#PieceState) within the torrent.
- `GET /fileState?ih=&path=`. Returns [file state](https://godoc.org/github.com/anacrolix/torrent#File.State) encoded as JSON.
- `POST /metainfo?ih=`. The request body is a bencoded metainfo, as typically appears in a `.torrent` file. The trackers and info bytes are applied to the torrent matching the info hash provided in the query. No fields in the metainfo are mandatory.
- `GET /metainfo?ih=`. returns a .torrent file containing the hash info.
Wherever a `?ih=` query parameter is expected, it can also be substituted by a `?magnet=` parameter instead.
## Example
Running the following command from a shell will launch VLC and start playing the Sintel movie stream from its public torrent.
```
vlc 'http://localhost:8080/data?magnet=magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&path=Sintel.mp4'
```