mirror of
https://github.com/YGGverse/aquatic.git
synced 2026-03-31 17:55:36 +00:00
README: move down architectural overview, other fixes
This commit is contained in:
parent
a9635bb713
commit
b0f17633d5
1 changed files with 7 additions and 6 deletions
13
README.md
13
README.md
|
|
@ -26,6 +26,7 @@ Features at a glance:
|
|||
- IPv4 and IPv6 support
|
||||
- Supports only allowing certain torrents, or forbiddding certain torrents
|
||||
- Built-in TLS support for HTTP and WebTorrent (no reverse proxy needed)
|
||||
- Licensed under Apache-2.0
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -84,7 +85,7 @@ Once done, run the tracker:
|
|||
./target/release/aquatic_ws -c "aquatic-ws-config.toml"
|
||||
```
|
||||
|
||||
### Configuration values
|
||||
### Notes on configuration values
|
||||
|
||||
Starting more `socket_workers` than `request_workers` is recommended. All
|
||||
implementations are quite IO-bound and spend a lot of their time reading from
|
||||
|
|
@ -111,10 +112,6 @@ parsing fails, the program exits. Later failures result in in emitting of
|
|||
an error-level log message, while successful updates of the access list result
|
||||
in emitting of an info-level log message.
|
||||
|
||||
## Architectural overview
|
||||
|
||||

|
||||
|
||||
## Details on implementations
|
||||
|
||||
### aquatic_udp: UDP BitTorrent tracker
|
||||
|
|
@ -195,9 +192,13 @@ corresponding load test binary:
|
|||
./scripts/run-load-test-ws.sh
|
||||
```
|
||||
|
||||
To fairly compare HTTP performance to opentracker, set keepalive to false in
|
||||
To fairly compare HTTP performance to opentracker, set `keep_alive` to false in
|
||||
`aquatic_http` settings.
|
||||
|
||||
## Architectural overview
|
||||
|
||||

|
||||
|
||||
## Copyright and license
|
||||
|
||||
Copyright (c) 2020-2022 Joakim Frostegård
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue