YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 17:55:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve README

Browse source
This commit is contained in:
Joakim Frostegård 2021-10-28 18:29:26 +02:00
parent 1fca54bfe9
commit b938a6c723
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -2,9 +2,8 @@
[![CargoBuildAndTest](https://github.com/greatest-ape/aquatic/actions/workflows/cargo-build-and-test.yml/badge.svg)](https://github.com/greatest-ape/aquatic/actions/workflows/cargo-build-and-test.yml) [![Test HTTP, UDP and WSS file transfer](https://github.com/greatest-ape/aquatic/actions/workflows/test-transfer.yml/badge.svg)](https://github.com/greatest-ape/aquatic/actions/workflows/test-transfer.yml) [![CargoBuildAndTest](https://github.com/greatest-ape/aquatic/actions/workflows/cargo-build-and-test.yml/badge.svg)](https://github.com/greatest-ape/aquatic/actions/workflows/cargo-build-and-test.yml) [![Test HTTP, UDP and WSS file transfer](https://github.com/greatest-ape/aquatic/actions/workflows/test-transfer.yml/badge.svg)](https://github.com/greatest-ape/aquatic/actions/workflows/test-transfer.yml)
Blazingly fast, multi-threaded BitTorrent tracker written in Rust. Blazingly fast, multi-threaded BitTorrent tracker written in Rust, consisting
of sub-implementations for different protocols:
Consists of sub-implementations for different protocols:
[BitTorrent over UDP]: https://libtorrent.org/udp_tracker_protocol.html [BitTorrent over UDP]: https://libtorrent.org/udp_tracker_protocol.html
[BitTorrent over HTTP]: https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol [BitTorrent over HTTP]: https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol
@ -20,12 +19,6 @@ Consists of sub-implementations for different protocols:
| aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ | | aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ |
| aquatic_ws | [WebTorrent], plain or with TLS ([native-tls]) | Cross-platform | | aquatic_ws | [WebTorrent], plain or with TLS ([native-tls]) | Cross-platform |
## Copyright and license
Copyright (c) 2020-2021 Joakim Frostegård
Distributed under Apache 2.0 license (details in `LICENSE` file.)
## Usage ## Usage
### Prerequisites ### Prerequisites
@ -145,6 +138,8 @@ Aims for compatibility with the [HTTP BitTorrent protocol], with some exceptions
`aquatic_http` has not been tested as much as `aquatic_udp` but likely works `aquatic_http` has not been tested as much as `aquatic_udp` but likely works
fine. fine.
#### TLS
A TLS certificate file (DER-encoded X.509) and a corresponding private key file A TLS certificate file (DER-encoded X.509) and a corresponding private key file
(DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format) are required. Set their (DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format) are required. Set their
paths in the configuration file, e.g.: paths in the configuration file, e.g.:
@ -235,6 +230,12 @@ This design means little waiting for locks on internal state occurs,
while network work can be efficiently distributed over multiple threads, while network work can be efficiently distributed over multiple threads,
making use of SO_REUSEPORT setting. making use of SO_REUSEPORT setting.
## Copyright and license
Copyright (c) 2020-2021 Joakim Frostegård
Distributed under Apache 2.0 license (details in `LICENSE` file.)
## Trivia ## Trivia
The tracker is called aquatic because it thrives under a torrent of bits ;-) The tracker is called aquatic because it thrives under a torrent of bits ;-)