Skip to content

Commit

Permalink
add repo info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
natesales committed Oct 16, 2020
1 parent bac48d9 commit c96f1d5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
The automatic BIRD configuration generator with bogon, IRR, RPKI, and max prefix filtering support.

### Installation
bcg depends on [bird2](https://gitlab.nic.cz/labs/bird/), [GoRTR](https://github.com/cloudflare/gortr), and [bgpq4](https://github.com/bgp/bgpq4). Make sure the `bird` and `gortr` daemons are running and `bgpq4` is in path before running bcg. bcg is available for amd64 as a prebuilt deb package and binary for each release. You can also build from source by cloning the repo and running `go build`
bcg depends on [bird2](https://gitlab.nic.cz/labs/bird/), [GoRTR](https://github.com/cloudflare/gortr), and [bgpq4](https://github.com/bgp/bgpq4). Make sure the `bird` and `gortr` daemons are running and `bgpq4` is in path before running bcg. bcg is available for amd64 as a prebuilt deb package and binary for each release. You can also build from source by cloning the repo and running `go build`. There is also a debian repo at `deb [trusted=true] https://natesales.net/repo/debian ./` which is highly developmental and does not have signing or any sort of verification. I'd highly recommend using the release binary or building from source.

#### Configuration
BCG can be configured in YAML, TOML, or JSON. All config file formats have the same configuration options but follow a different capitalization structure. YAML and JSON use all lowercase parameter names and TOML uses CapsCase with acronyms capitalized. For example, `router-id` in YAML and JSON is `Router-ID` in TOML.
Expand Down

0 comments on commit c96f1d5

Please sign in to comment.