diff --git a/Makefile b/Makefile index bf75803..5a10620 100644 --- a/Makefile +++ b/Makefile @@ -99,5 +99,3 @@ clean: rm -f $(PROG)-osx-$(ARCH) rm -f $(PROG)-linux-$(ARCH) rm -rf $(DIST) - - diff --git a/README.md b/README.md index 8255a70..23e661a 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,20 @@ Running `go get github.com/ecix/birdwatcher` will give you a binary. You might need to cross-compile it for your bird-running servive (`GOARCH` and `GOOS` are your friends). +We provide a Makefile for more advanced compilation/configuration. +Running `make linux` will create a Linux executable (by default for +`amd64`, but that is configurable by providing the `ARCH` argument +to the Makefile). + +## Configuration + +An example config with sane defaults is provided in +[etc/ecix/birdwatcher.conf](https://github.com/ecix/birdwatcher/blob/master/etc/ecix/birdwatcher.conf). +You should be able to use it out of the box. If you need +to change it, it is well-commented and hopefully intuitive. +If you do not know how to configure it, please consider opening +[an issue](https://github.com/ecix/birdwatcher/issues/new). + ## Why The [INEX implementation](https://github.com/inex/birdseye) of diff --git a/etc/ecix/birdwatcher.conf b/etc/ecix/birdwatcher.conf index 5a5e20c..3f3d7e6 100644 --- a/etc/ecix/birdwatcher.conf +++ b/etc/ecix/birdwatcher.conf @@ -3,10 +3,10 @@ # [server] -# Restrict access to certain IPs. Leave empty to allow from all. +# Restrict access to certain IPs. Leave empty to allow from all. allow_from = [] -# All modules: +# All modules: # status # protocols # protocols_bgp