nedifinita
/
bird-looking-glass-proxy
mirror of https://github.com/undef-i/bird-looking-glass-proxy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Release v0.0.1

This commit is contained in:
undef-i 2023-03-18 18:50:13 +08:00
parent 6fe3cc6331
commit cfb778ea64
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -9,13 +9,13 @@ OPTIONS:
-h, --help Print help information
```
## Quick Start
0. Make sure that Bird and Traceroute are installed and available.
1. Obtain the binary executable by either downloading it from the release or compiling the project with Cargo.
2. Use the command bird-looking-glass-proxy --example > config.toml to create a template configuration file and modify it to your needs.
0. Make sure that `bird` and `traceroute` are installed and available.
1. Obtain the binary executable by either downloading it from the release or compiling the project with `cargo`.
2. Use the command `bird-looking-glass-proxy --example > config.toml` to create a template configuration file and modify it to your needs.
3. Run the executable.
### Tips
The default configuration file is located at `./config.toml`, but you can customize the file location using the `-c` or `--config` parameter.
## Known issues.
* Versions built with the *-unknown-linux-gnu toolchain may not function correctly on systems with GLIBC versions below 2.35. To resolve this, use a statically linked version built with the *-unknown-linux-musl toolchain.
* Versions built with the `*-unknown-linux-gnu` toolchain may not function correctly on systems with `GLIBC` versions below `2.35`. To resolve this, use a statically linked version built with the `*-unknown-linux-musl` toolchain.