Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Luminarys/synapse
Synapse BitTorrent Daemon
https://github.com/Luminarys/synapse
Last synced: 3 months ago
JSON representation
Synapse BitTorrent Daemon
- Host: GitHub
- URL: https://github.com/Luminarys/synapse
- Owner: Luminarys
- License: isc
- Created: 2017-08-20T17:05:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T18:49:57.000Z (about 1 year ago)
- Last Synced: 2024-08-09T03:27:22.675Z (5 months ago)
- Language: Rust
- Homepage: https://synapse-bt.org
- Size: 1.71 MB
- Stars: 853
- Watchers: 22
- Forks: 48
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust - Luminarys/synapse
- awesome-rust-cn - Luminarys/synapse
- awesome-rust-zh - Luminarys/synapse - ci.org/Luminarys/synapse.svg?branch=master)](https://travis-ci.org/Luminarys/synapse) (应用 / 系统工具)
- awesome-rust - Luminarys/synapse - Flexible and fast BitTorrent daemon. (Applications / System tools)
- awesome-rust-cn - Luminarys/synapse - ci.org/Luminarys/synapse.svg?branch=master)](https://travis-ci.org/Luminarys/synapse) (应用 / System tools)
- awesome-starred - Luminarys/synapse - Synapse BitTorrent Daemon (others)
- fucking-awesome-rust - Luminarys/synapse - Flexible and fast BitTorrent daemon. (Applications / System tools)
- fucking-awesome-rust - Luminarys/synapse - Flexible and fast BitTorrent daemon. (Applications / System tools)
README
# synapse
[](https://github.com/Luminarys/synapse/actions/workflows/rust.yml)
Synapse is a flexible and fast BitTorrent daemon.
It currently supports most systems which implement epoll or kqueue, with a focus on 64-bit linux servers.
## About
* Event based RPC using websockets
* HTTP downloads and TLS for easy server usage
* Can be used via web client with minimal setup - see [receptor](https://web.synapse-bt.org)
* See [this wiki page](https://github.com/Luminarys/synapse/wiki/Feature-Stability) for an overview of stability
## Installation
### Package
A list of packages can be found on [this wiki page](https://github.com/Luminarys/synapse/wiki/Third-party-packages).
### Compiling
Install dependencies:
- rustc >= 1.39.0
- cargo >= 0.18
- gcc | clang
Synapse and sycli can be installed with:
```
cargo build --release --all
cargo install --path .
cargo install --path ./sycli/
```
If you'd just like to install sycli:
```
cargo build --release -p sycli
cargo install --path ./sycli/
```
## Configuration
Synapse expects its configuration file to be present at `$XDG_CONFIG_DIR/synapse.toml`,
or `~/.config/synapse.toml`.
If it is not present or invalid, a default configuration will be used.
These defaults are given in `example_config.toml`.
Sycli can be configured in a similar manner, using `sycli.toml`.
### Desktop application
Copy [`share/synapse/applications/synapse.desktop`] to `$XDG_DATA_HOME/applications` or `~/.local/share/applications`.
[`share/synapse/applications/synapse.desktop`]: share/synapse/applications/synapse.desktop
[XDG MIME Applications] example configuration:
`~/.config/mimeapps.list`
``` ini
[Default Applications]
x-scheme-handler/magnet=synapse.desktop
```
[XDG MIME Applications]: https://wiki.archlinux.org/index.php/XDG_MIME_Applications
## Development
Please see [this issue](https://github.com/Luminarys/synapse/issues/1) for details on development status.
If you're interested in developing a client for synapse, see `doc/RPC` for the current RPC spec.
if you'd like to contribute to synapse, see `doc/HACKING`.