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
Description
5 Commits 1 Branch 4 Tags 80 KiB
Rust 100%
Go to file
El Nedifinita f7db1b52ed
Update README.md 		2023-03-18 21:17:11 +08:00
.github/workflows Initializing commit 2023-03-18 18:34:39 +08:00
.idea Initializing commit 2023-03-18 18:34:39 +08:00
.vscode Initializing commit 2023-03-18 18:34:39 +08:00
src Initializing commit 2023-03-18 18:34:39 +08:00
.gitignore Initializing commit 2023-03-18 18:34:39 +08:00
Cargo.lock Initializing commit 2023-03-18 18:34:39 +08:00
Cargo.toml Initializing commit 2023-03-18 18:34:39 +08:00
LICENSE Initial commit 2023-03-18 20:53:37 +08:00
README.md Update README.md 2023-03-18 21:17:11 +08:00
config.toml Initializing commit 2023-03-18 18:34:39 +08:00

README.md

bird-looking-glass

USAGE:
    bird-looking-glass-proxy [OPTIONS]

OPTIONS:
    -c, --config <FILE>    Set the config file
    -e, --example          Export sample config file
    -h, --help             Print help information

Quick Start

  1. Make sure that bird and traceroute are installed and available.
  2. Obtain the binary executable by either downloading it from the release or compiling the project with cargo.
  3. Use the command bird-looking-glass-proxy --example > config.toml to create a template configuration file and modify it to your needs.
  4. 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.