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 files

Browse source
This commit is contained in:
Joakim Frostegård 2024-01-27 17:46:49 +01:00
parent b356e30f01
commit 7d4ba6940b
4 changed files with 34 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -46,10 +46,10 @@ the table above.
## Copyright and license ## Copyright and license
Copyright (c) 2020-2023 Joakim Frostegård Copyright (c) Joakim Frostegård
Distributed under the terms of the Apache 2.0 license. Please refer to the Distributed under the terms of the Apache License, Version 2.0. Please refer to
`LICENSE` file in the repository root directory for details. the `LICENSE` file in the repository root directory for details.
## Trivia ## Trivia

18
crates/http/README.md
View file

@ -25,10 +25,11 @@ More benchmark details are available [here](../../documents/aquatic-http-load-te
- Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended)
- Install cmake with your package manager (e.g., `apt-get install cmake`) - Install cmake with your package manager (e.g., `apt-get install cmake`)
- Clone this git repository and enter its root directory - Clone this git repository and build the application:
- Build the application:
```sh ```sh
git clone https://github.com/greatest-ape/aquatic.git && cd aquatic
# Recommended: tell Rust to enable support for all SIMD extensions present on # Recommended: tell Rust to enable support for all SIMD extensions present on
# current CPU except for those relating to AVX-512. (If you run a processor # current CPU except for those relating to AVX-512. (If you run a processor
# that doesn't clock down when using AVX-512, you can enable those instructions # that doesn't clock down when using AVX-512, you can enable those instructions
@ -51,7 +52,8 @@ Make necessary adjustments to the file. You will likely want to adjust `address`
To run over TLS, configure certificate and private key files. To run over TLS, configure certificate and private key files.
Running behind a reverse proxy is supported. Running behind a reverse proxy is supported. Please refer to the config file
for details.
### Running ### Running
@ -83,7 +85,9 @@ configuration files in a similar manner to the tracker application.
After starting the tracker, run the load tester: After starting the tracker, run the load tester:
```sh ```sh
./scripts/run-load-test-http.sh . ./scripts/env-native-cpu-without-avx-512 # Optional
cargo build --release -p aquatic_http_load_test -- --help
``` ```
## Details ## Details
@ -107,7 +111,7 @@ fine in production.
## Copyright and license ## Copyright and license
Copyright (c) 2020-2023 Joakim Frostegård Copyright (c) Joakim Frostegård
Distributed under the terms of the Apache 2.0 license. Please refer to the Distributed under the terms of the Apache License, Version 2.0. Please refer to
`LICENSE` file in the repository root directory for details. the `LICENSE` file in the repository root directory for details.

15
crates/udp/README.md
View file

@ -31,10 +31,11 @@ More benchmark details are available [here](../../documents/aquatic-udp-load-tes
- Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended)
- Install cmake with your package manager (e.g., `apt-get install cmake`) - Install cmake with your package manager (e.g., `apt-get install cmake`)
- Clone this git repository and enter its root directory - Clone this git repository and build the application:
- Build the application:
```sh ```sh
git clone https://github.com/greatest-ape/aquatic.git && cd aquatic
# Recommended: tell Rust to enable support for all SIMD extensions present on # Recommended: tell Rust to enable support for all SIMD extensions present on
# current CPU except for those relating to AVX-512. (If you run a processor # current CPU except for those relating to AVX-512. (If you run a processor
# that doesn't clock down when using AVX-512, you can enable those instructions # that doesn't clock down when using AVX-512, you can enable those instructions
@ -73,7 +74,9 @@ configuration files in a similar manner to the tracker application.
After starting the tracker, run the load tester: After starting the tracker, run the load tester:
```sh ```sh
./scripts/run-load-test-udp.sh . ./scripts/env-native-cpu-without-avx-512 # Optional
cargo build --release -p aquatic_udp_load_test -- --help
``` ```
## Details ## Details
@ -85,7 +88,7 @@ Implements [BEP 015](https://www.bittorrent.org/beps/bep_0015.html) ([more detai
## Copyright and license ## Copyright and license
Copyright (c) 2020-2023 Joakim Frostegård Copyright (c) Joakim Frostegård
Distributed under the terms of the Apache 2.0 license. Please refer to the Distributed under the terms of the Apache License, Version 2.0. Please refer to
`LICENSE` file in the repository root directory for details. the `LICENSE` file in the repository root directory for details.

17
crates/ws/README.md
View file

@ -29,10 +29,11 @@ More details are available [here](../../documents/aquatic-ws-load-test-2023-01-2
- Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended)
- Install cmake with your package manager (e.g., `apt-get install cmake`) - Install cmake with your package manager (e.g., `apt-get install cmake`)
- Clone this git repository and enter its root directory - Clone this git repository and build the application:
- Build the application:
```sh ```sh
git clone https://github.com/greatest-ape/aquatic.git && cd aquatic
# Recommended: tell Rust to enable support for all SIMD extensions present on # Recommended: tell Rust to enable support for all SIMD extensions present on
# current CPU except for those relating to AVX-512. (If you run a processor # current CPU except for those relating to AVX-512. (If you run a processor
# that doesn't clock down when using AVX-512, you can enable those instructions # that doesn't clock down when using AVX-512, you can enable those instructions
@ -53,6 +54,8 @@ Generate the configuration file:
Make necessary adjustments to the file. You will likely want to adjust `address` Make necessary adjustments to the file. You will likely want to adjust `address`
(listening address) under the `network` section. (listening address) under the `network` section.
To run over TLS, configure certificate and private key files.
Running behind a reverse proxy is supported, as long as IPv4 requests are Running behind a reverse proxy is supported, as long as IPv4 requests are
proxied to IPv4 requests, and IPv6 requests to IPv6 requests. proxied to IPv4 requests, and IPv6 requests to IPv6 requests.
@ -86,7 +89,9 @@ configuration files in a similar manner to the tracker application.
After starting the tracker, run the load tester: After starting the tracker, run the load tester:
```sh ```sh
./scripts/run-load-test-ws.sh . ./scripts/env-native-cpu-without-avx-512 # Optional
cargo build --release -p aquatic_ws_load_test -- --help
``` ```
## Details ## Details
@ -102,8 +107,8 @@ fine in production.
## Copyright and license ## Copyright and license
Copyright (c) 2020-2023 Joakim Frostegård Copyright (c) Joakim Frostegård
Distributed under the terms of the Apache 2.0 license. Please refer to the Distributed under the terms of the Apache License, Version 2.0. Please refer to
`LICENSE` file in the repository root directory for details. the `LICENSE` file in the repository root directory for details.