2.6 KiB
Installation
Running BGPalerter from binaries - Quick Setup
-
Download the binary here (be sure to select the one for your OS)
-
Execute the binary (e.g.
chmod +x bgpalerter-linux-x64 && ./bgpalerter-linux-x64
)
The first time you run it, the auto-configuration will start.
Running BGPalerter from binaries - All steps
Linux
-
Download the binary:
wget https://github.com/nttgin/BGPalerter/releases/latest/download/bgpalerter-linux-x64
-
Download
config.yml.example
asconfig.yml
(in the same directory of the binary) -
Make the binary executable (e.g.
chmod +x bgpalerter-linux-x64
) -
Auto-configure it:
./bgpalerter-linux-x64 generate -a _YOUR_ASN_ -o prefixes.yml -i -m
-
Run it:
./bgpalerter-linux-x64
Or usenohup ./bgpalerter-linux-x64 &
to leave it running after you close the terminal
Mac
-
Download the binary here.
-
Download
config.yml.example
asconfig.yml
(in the same directory of the binary) -
Make the binary executable (e.g.
chmod +x bgpalerter-macos-x64
) -
Auto-configure it:
./bgpalerter-macos-x64 generate -a _YOUR_ASN_ -o prefixes.yml -i -m
-
Run it:
./bgpalerter-macos-x64
Windows
-
Download the binary here.
-
Download
config.yml.example
asconfig.yml
(in the same directory of the binary) -
Open cmd (press
ctrl + R
and typecmd
) andcd
on the directory where you downloaded the binary (usuallycd C:\Users\_USER_\Downloads
) -
Run it:
bgpalerter-win-x64.exe
Running BGPalerter from the source code
-
Git clone this repo.
-
Install Node.js (version >= 10.16) and npm (installing node and npm).
-
Execute
npm install
to install all dependencies. -
Run
npm run watch-and-serve
to run the application. At every file change it will self-reload.
Running BGPalerter in Docker
BGPalerter is available in Docker Hub here.
There are two main builds:
latest
stable version for production monitoring;dev
reflects the last commit in thedev
branch. Use this only for development purposes.
Additionally, each release has its own build in case you want to revet back to an older version.