Skip to content

Commit

Permalink
prepare v0.7.5 release
Browse files Browse the repository at this point in the history
  • Loading branch information
digizeph committed Aug 23, 2024
1 parent 91388b8 commit 3386bae
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

All notable changes to this project will be documented in this file.

## v0.7.5 - 2024-08-23

### [NEW] deploy at fly.io

* add a deployment config file for fly.io

### Bugfix

* fix an issue where the API returns URL with additional `/bgpdata` for some new route-views collectors.

### Documentation

* improved documentation on deploying bgpkit-broker services.

## v0.7.4 - 2024-08-22

### Highlights
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bgpkit-broker"
version = "0.7.4"
version = "0.7.5"
edition = "2021"
authors = ["Mingwei Zhang <[email protected]>"]
readme = "README.md"
Expand Down
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,67 @@ missing the following collectors:
| routeviews | iraq-ixp.bgw | Iraq | 2024-04-13 00:01:00 | http://archive.routeviews.org/iraq-ixp.bgw/bgpdata |
```

## Deployment

### Docker

You can deploy the BGPKIT Broker service using the provided Docker image. The image is available on Docker Hub
at [bgpkit/broker](https://hub.docker.com/r/bgpkit/bgpkit-broker).

To run in deattached mode (as a service):

```bash
docker run -d -p 40064:40064 bgpkit/bgpkit-broker:latest
```

You can also build the Docker image from the source code:

```bash
docker build -t bgpkit/bgpkit-broker:latest .
```

### On-premises CLI

You can also start a BGPKIT Broker instance on your own server using the `bgpkit-broker` CLI tool with the following
command:

```bash
bgpkit-broker serve YOUR_SQLITE_3_FILE_PATH.sqlite3 --bootstrap --silent
```

* `YOUR_SQLITE_3_FILE_PATH.sqlite3` is the path to the SQLite3 database file.
* `--bootstrap` flag is used to bootstrap the database content from the provided daily backup database.
* `--silent` flag is used to disable the bootstrap download progress bar.

On a systemd managed OS like Debian or Ubuntu, you can also use the following service file to manage the BGPKIT Broker
service:

```ini
[Unit]
Description=BGPKIT Broker Service
After=network.target

[Service]
ExecStart=/usr/local/bin/bgpkit-broker serve /var/lib/bgpkit/broker.sqlite3
Restart=on-failure
User=root

[Install]
WantedBy=multi-user.target
```

Put this file at `/etc/systemd/system/bgpkit-broker.service` and run `systemctl daemon-reload` to reload the service
list, and then you can start the service with `systemctl start bgpkit-broker`.
To enable the service to start on boot, run `systemctl enable bgpkit-broker`.

## Deploy on Fly.io

You can deploy the BGPKIT Broker service on [Fly.io](https://fly.io) using the
provided [`fly.toml` configuration file](fly.toml).

Note that you may need to adjust to machine size and region based on your needs.
Currently, `1gb` memory and `1` shared CPU is enough for the BGPKIT Broker service.

## Data Provider

If you have publicly available data and want to be indexed BGPKIT Broker service, please email us at
Expand Down

0 comments on commit 3386bae

Please sign in to comment.