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
bird-looking-glass-proxy/README.md

3.9 KiB
Raw Blame History

Bird Looking Glass Proxy

Contributors Forks Stargazers Issues MIT License

Bird Looking Glass Proxy is a svelte web API contrived to administer BIRD and Traceroute instances, furnishing a streamlined interface for network diagnostics and management.

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

Commencing

To commence with Bird Looking Glass Proxy, follow the steps expounded below:

Requisites

Before you embark, ensure you have the subsequent requisites:

  • BIRD: Ensure that BIRD (BGP Internet Routing Daemon) is installed and configured properly. Bird Looking Glass Proxy relies on BIRD for routing information.
  • Traceroute: Make sure that the traceroute utility is installed and available in your system. It is utilized for network diagnostics and troubleshooting, which is imperative for the functionality of Bird Looking Glass Proxy.
  • Rust: If you intend to compile the project from source, ensure you have Rust installed. You can install Rust by following the instructions on rustup.rs.

Installation

You can procure the binary executable for Bird Looking Glass Proxy from the releases page. Alternatively, you have the option to compile the project on your own.

  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. The compiled binary will be available in the target/release directory.
  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.

  • 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.

Perspective

Our future aspirations for Bird Looking Glass Proxy encompass:

  • Enhancing compatibility with different system architectures.
  • Augmenting logging and error handling mechanisms.
  • Implementing additional features for enhanced customization.

Collaborative Endeavors

Contributions are cordially invited! Feel unshackled to open issues or submit pull requests to aid in ameliorating Bird Looking Glass Proxy.

License

Bird Looking Glass Proxy is licensed under the GNU General Public License v3.0 (GPLv3). Peruse the LICENSE file for details.

Contact

For inquiries or support, please reach out to i@nedifinita.com.