# bgp_platform

**Repository Path**: Timothy-LiuXuefeng/bgp_platform

## Basic Information

- **Project Name**: bgp_platform
- **Description**: Mirror of bgp_platform - BGP outage detection experimental platform
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-08
- **Last Updated**: 2024-11-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bgp_platform

bgp_platform - BGP outage detection experimental platform

Origin Repo: <https://github.com/Timothy-Liuxf/bgp_platform>

## How to Build

### Prerequisites

+ Linux operating system
+ C++ compiler which supports C++17
+ GNU Autoconf and GNU Automake
+ `libpq` and `libpqxx-6.4`
+ `bgpdump`
+ Python 3 with PyTorch

or

+ Docker

### Clone this repository

```bash
$ git clone --recursive https://github.com/Timothy-Liuxf/bgp_platform.git
$ cd bgp_platform
```

or

```bash
$ git clone https://github.com/Timothy-Liuxf/bgp_platform.git
$ cd bgp_platform
$ git submodule update --init --recursive
```

### Build with Docker (Recommended)

#### Build base image

```bash
$ docker build . -f Dockerfile.base -t <base image name>
```

#### Build target image

1. Open `Dockerfile`:

  ```Dockerfile
  FROM timothyliuxf/bgp_platform_base AS builder
  ```

  Then change `timothyliuxf/bgp_platform_base` to `<base image name>` you set in the previous step.

2. Build the target image:

  ```bash
  $ docker build . -t <target image name>
  ```

### Build on a local machine

#### Configure build system

```bash
# Requires GNU Autoconf and GNU Automake

$ autoreconf -i
$ [ENV=VAL] ./configure
```

The `ENV` and `VAL` can be:

+ `BUILD_CONFIG`: Choose configuration.
  + `Debug` / `debug`: Debug configuration.
  + `Release` / `release` (default): Release configuration.
+ `CXX`: The C++ compiler to use. The default value is `g++`.

#### Build the target

```bash
$ make -j$(nproc)
```

## How to Run

### Setup Database

Setup a [PostgreSQL](https://www.postgresql.org/) server.

### Configuration

Write configurations in `config/config.json`. Take [`config/examples/config.json`](config/examples/config.json) for an example.

### Run the program

#### Run with docker

+ Mount the directory where the `config.json` is located to `/app/config`.
+ Mount the directory where the initalization information files are located to `/app/info`.
+ Mount the directory where the data files are located to `/app/data`.

Take [`scripts/launch_docker.sh`](scripts/launch_docker.sh) for an example.

#### Run on a local machine

```bash
$ ./build/bin/bgp_platform [options]
```