Description
Go to file
nedifinita 5f6e04c3a9 Edit README. 2024-02-17 13:41:33 +08:00
.github/workflows Fix GitHub Actions workflow. 2023-08-07 23:56:31 +08:00
src Add support for the shared_secret field. 2023-08-07 23:37:42 +08:00
.gitignore Update Archive 2023-03-19 06:19:14 +08:00
Cargo.lock Add support for the shared_secret field. 2023-08-07 23:37:42 +08:00
Cargo.toml Add support for the shared_secret field. 2023-08-07 23:37:42 +08:00
LICENSE Initial commit 2023-03-18 20:53:37 +08:00
README.md Edit README. 2024-02-17 13:41:33 +08:00
config.toml Add support for the shared_secret field. 2023-08-07 23:37:42 +08:00

README.md

bird-looking-glass-proxy

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

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.