D4
/
BGP-Ranking
mirror of https://github.com/D4-project/BGP-Ranking
2
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #27 from fukusuket/update-readme 

fix: update README  Server Installation command
main
Raphaël Vinot 2023-08-10 22:23:34 +02:00 committed by GitHub
parent f81495be99 a11d766239
commit 81e9738386
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -145,7 +145,7 @@ curl -X POST -d '{"asn": "5577", "period": 5}' https://bgpranking-ng.circl.lu/js
# Server Installation (if you want to run your own) # Server Installation (if you want to run your own)
**IMPORTANT**: Use [pipenv](https://pipenv.readthedocs.io/en/latest/) **IMPORTANT**: Use [poetry](https://github.com/python-poetry/poetry#installation)
**NOTE**: Yes, it requires python3.6+. No, it will never support anything older. **NOTE**: Yes, it requires python3.6+. No, it will never support anything older.
@ -159,34 +159,35 @@ make
make test make test
cd .. cd ..
``` ```
**Note**: If it fails, have a look at [the documentation](https://github.com/redis/redis#building-redis).
## Install ardb ## Install kvrocks
```bash ```bash
git clone https://github.com/yinqiwen/ardb.git git clone https://github.com/KvrocksLabs/kvrocks.git
cd ardb cd kvrocks
DISABLE_WARNING_AS_ERROR=1 make # ardb (more precisely rocksdb) doesn't compile on ubuntu 18.04 unless you disable warning as error git checkout 2.5
./x.py build
cd .. cd ..
``` ```
**Note**: If it fails, have a look at [the documentation](https://github.com/apache/kvrocks#build-and-run-kvrocks).
## Install & run BGP Ranking ## Install & run BGP Ranking
```bash ```bash
git clone https://github.com/D4-project/BGP-Ranking.git git clone https://github.com/D4-project/BGP-Ranking.git
cd BGP-Ranking cd BGP-Ranking
pipenv install poetry install
echo BGPRANKING_HOME="'`pwd`'" > .env echo BGPRANKING_HOME="'`pwd`'" > .env
pipenv shell poetry shell
# Starts all the backend # Starts all the backend
start.py start
# Start the web interface
start_website.py
``` ```
## Shutdown BGP Ranking ## Shutdown BGP Ranking
```bash ```bash
stop.py stop
``` ```
# Directory structure # Directory structure
@ -280,7 +281,7 @@ And the following keys:
<asn>|v6|ipcount = <Total amount of IP v6 addresses originating this AS> <asn>|v6|ipcount = <Total amount of IP v6 addresses originating this AS>
``` ```
## Long term storage (ardb, port 16579) ## Long term storage (kvrocks, port 5188)
*Usage*: Stores the IPs with the required meta informations required for ranking. *Usage*: Stores the IPs with the required meta informations required for ranking.

2
ranking/run_kvrocks.sh
View File

@ -3,4 +3,4 @@
set -e set -e
set -x set -x
../../kvrocks/src/kvrocks -c kvrocks.conf ../../kvrocks/build/kvrocks -c kvrocks.conf