Created Aquatic (markdown)

oooo-ps 2025-07-08 16:35:13 +03:00
parent 65986ce81e
commit 7785753f64

37
Aquatic.md Normal file

@ -0,0 +1,37 @@
This crawler requires [patch #233](https://github.com/greatest-ape/aquatic/pull/233).
## Build from source
* `git clone https://github.com/YGGverse/aquatic.git && cd aquatic`
* `git checkout info-hash-api`
* `cargo build --release -p aquatic_udp`
* `sudo install sudo install target/release/aquatic_udp /usr/local/bin/aquatic_udp`
## Configuration
* `aquatic_udp -p > /path/to/aquatic.toml`
* `nano /path/to/aquatic.toml`
* `write_bin_to_file` - set as `true`
* `bin_info_hash_ipv4_file_path` - set path (if IPv4 in use)
* `bin_info_hash_ipv6_file_path` - set path (if IPv6 in use)
* open ports in the firewall according for the `address_ipv4` and `address_ipv6` configuration
## Run
```
aquatic_udp -c /path/to/aquatic.toml
```
## Use
[Install](https://github.com/YGGverse/aquatic-crawler#install) and run `aquatic-crawler` with following options:
``` bash
aquatic-crawler --infohash bin_info_hash_ipv4_file_path.bin\
--infohash bin_info_hash_ipv6_file_path.bin\
--tracker udp://host1:port\
--tracker udp://host2:port\
--preload /path/to/directory\
--enable-tcp
```
* replace `infohash` with your `aquatic` configuration values