https://github.com/i96751414/torrest
torrent service with a REST api
https://github.com/i96751414/torrest
go golang libtorrent libtorrent-rasterbar rest
Last synced: 5 months ago
JSON representation
torrent service with a REST api
- Host: GitHub
- URL: https://github.com/i96751414/torrest
- Owner: i96751414
- License: mit
- Created: 2019-12-20T23:48:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T02:31:56.000Z (about 3 years ago)
- Last Synced: 2024-06-20T07:57:40.734Z (about 2 years ago)
- Topics: go, golang, libtorrent, libtorrent-rasterbar, rest
- Language: Go
- Homepage:
- Size: 179 KB
- Stars: 14
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Torrest
[](https://github.com/i96751414/torrest/actions?query=workflow%3Abuild)
[](https://www.codacy.com/gh/i96751414/torrest/dashboard?utm_source=github.com&utm_medium=referral&utm_content=i96751414/torrest&utm_campaign=Badge_Grade)
Torrent service with a REST api, specially made for streaming.
> :warning: **This project will soon be deprecated in favor of [torrest-cpp](https://github.com/i96751414/torrest-cpp)**
## Building
1. Build the [cross-compiler](https://github.com/i96751414/cross-compiler) and [libtorrent-go](https://github.com/i96751414/libtorrent-go) images, or alternatively, pull the libtorrent-go images from [Docker Hub](https://hub.docker.com/r/i96751414/libtorrent-go):
```shell script
make pull-all
```
This will pull all platforms images. For a specific platform, run:
```shell script
make pull PLATFORM=linux-x64
```
2. Build torrest binaries:
```shell script
make all
```
Or if you want to build for a specific platform:
```shell script
make linux-x64
```
The list of supported platforms is:
|Android|Darwin|Linux|Windows|
|-------|------|-----|-------|
|android-arm
android-arm64
android-x64
android-x86
|darwin-x64
|linux-arm
linux-armv7
linux-arm64
linux-x64
linux-x86|windows-x64
windows-x86
|
### Swagger
For building swagger docs, you must run `go get -u github.com/swaggo/swag/cmd/swag` to install all the necessary dependencies, and then run `make swag`.
The last command must be executed before building the binaries, so the documents are included when building.
Swagger-ui will then be available on: http://localhost:8080/swagger/index.html.