mirror/nlnetlabs-rtrtr
1
0
Fork 0
mirror of https://github.com/NLnetLabs/rtrtr.git synced 2024-05-11 05:55:07 +00:00
Code Issues Releases Activity

More text more concise

Browse Source
This commit is contained in:
Alex Band
2022-02-09 12:37:48 +01:00
committed by GitHub
parent 76a31c9ac1
commit 4625de8419
1 changed files with 13 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
README.md
View File

@ -1,9 +1,9 @@
# RTRTR – An RPKI data proxy
![ci](https://github.com/NLnetLabs/rtrtr/workflows/ci/badge.svg)
![CI](https://github.com/NLnetLabs/rtrtr/workflows/ci/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/rtrtr/badge/?version=stable)](https://rtrtr.docs.nlnetlabs.nl/en/stable/?badge=stable)
[![](https://img.shields.io/crates/v/rtrtr.svg?color=brightgreen)](https://crates.io/crates/rtrtr)
[![](https://img.shields.io/discord/818584154278199396?label=rpki%20on%20discord&logo=discord)](https://discord.gg/8dvKB5Ykhy)
[![crates.io](https://img.shields.io/crates/v/rtrtr.svg?color=brightgreen)](https://crates.io/crates/rtrtr)
[![Discord](https://img.shields.io/discord/818584154278199396?label=rpki%20on%20discord&logo=discord)](https://discord.gg/8dvKB5Ykhy)
RTRTR is an RPKI data proxy, designed to collect Validated ROA Payloads
from one or more sources in multiple formats and dispatch it onwards. It
@ -20,240 +20,16 @@ If you have feedback, we would love to hear from you. Don’t hesitate to [creat
an issue on Github](https://github.com/NLnetLabs/rtrtr/issues/new) or post
a message on our [RPKI mailing
list](https://lists.nlnetlabs.nl/mailman/listinfo/rpki) or [Discord
server](https://discord.gg/8dvKB5Ykhy). You can learn more by reading the
[RTRTR documentation](https://rtrtr.docs.nlnetlabs.nl/) and the
[RPKI technology documentation](https://rpki.readthedocs.io/) on Read the Docs.
server](https://discord.gg/8dvKB5Ykhy).
## Architecture
## Getting Started
RTRTR is a very versatile tool. It comes with a number of components for
different purposes that can be connected to serve multiple use cases.
There are two classes of components: _Units_ take filtering data from
somewhere – this could be other units or external sources –, and produce and
constantly update one new set of data. _Targets_ take the data set from
one particular unit and serve it to an external party.
Getting started with RTRTR is really easy by installing a binary package
for either Debian and Ubuntu or for Red Hat Enterprise Linux (RHEL) and
compatible systems such as Rocky Linux. Alternatively, you can run with
Docker or build from the source code using Cargo, Rust’s build system and
package manager.
Which components RTRTR will use and how they are connected is described in
[the documentation](https://rtrtr.docs.nlnetlabs.nl/) Also, an example
config file can be found in [`etc/rtrtr.conf`].
## Quick Start with Binary Packages
Getting started with RTRTR is really easy by installing a binary package for
either Debian and Ubuntu or for Red Hat Enterprise Linux (RHEL), CentOS and
Rocky Linux. The [NLnet Labs software package
repository](https://packages.nlnetlabs.nl) currently has packages available for
the `amd64`/`x86_64` architecture only. Alternatively, you can run with Docker
or build from Cargo, Rust's build system and package manager.
### Debian
Our software package repository has binary packages available for Debian 9
(stretch), 10 (buster) and 11 (bullseye).
First update the `apt` package index:
```bash
sudo apt update
```
Then install packages to allow ``apt`` to use a repository over HTTPS:
```bash
sudo apt install \
ca-certificates \
curl \
gnupg \
lsb-release
```
Add the GPG key from NLnet Labs:
```bash
curl -fsSL https://packages.nlnetlabs.nl/aptkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/nlnetlabs-archive-keyring.gpg
```
Now, use the following command to set up the *main* repository:
```bash
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/debian \
$(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/nlnetlabs.list > /dev/null
```
Update the ``apt`` package index once more:
```bash
sudo apt update
```
You can now install RTRTR with:
```bash
sudo apt install rtrtr
```
### Ubuntu
Our software package repository has binary packages available for Ubuntu 16.x
(Xenial Xerus), 18.x (Bionic Beaver) and 20.x (Focal Fossa).
First update the `apt` package index:
```bash
sudo apt update
```
Then install packages to allow ``apt`` to use a repository over HTTPS:
```bash
sudo apt install \
ca-certificates \
curl \
gnupg \
lsb-release
```
Add the GPG key from NLnet Labs:
```bash
curl -fsSL https://packages.nlnetlabs.nl/aptkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/nlnetlabs-archive-keyring.gpg
```
Now, use the following command to set up the *main* repository:
```bash
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/nlnetlabs-archive-keyring.gpg] https://packages.nlnetlabs.nl/linux/ubuntu \
$(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/nlnetlabs.list > /dev/null
```
Update the ``apt`` package index once more:
```bash
sudo apt update
```
You can now install RTRTR with:
```bash
sudo apt install rtrtr
```
### RHEL/CentOS
Create a file named `/etc/yum.repos.d/nlnetlabs.repo`, enter this configuration
and save it:
```bash
[nlnetlabs]
name=NLnet Labs
baseurl=https://packages.nlnetlabs.nl/linux/centos/$releasever/main/$basearch
enabled=1
```
Then run the following command to add the public key
```bash
sudo rpm --import https://packages.nlnetlabs.nl/aptkey.asc
```
You can then install RTRTR by running this command
```bash
sudo yum install -y rtrtr
```
### Setting up RTRTR
You can now configure RTRTR by editing `/etc/rtrtr.conf` and start it with
`sudo systemctl enable --now rtrtr`. You can check the status with the
command `sudo systemctl status rtrtr` and view the logs with
`sudo journalctl --unit=rtrtr`.
## Quick Start with Cargo
If you have already installed Routinator, this should all be somewhat
familiar.
Assuming you have a newly installed Debian or Ubuntu machine, you will need
to install the C toolchain and Rust. You can then install RTRTR using
Cargo, Rust’s build tool.
```bash
apt install build-essential
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env
cargo install --locked rtrtr
```
If you have an older version of Rust and RTRTR, you can update using
```bash
rustup update
cargo install --locked --force rtrtr
```
If you want to try the main branch from the repository instead of a
release version, you can run
```bash
cargo install --git https://github.com/NLnetLabs/rtrtr.git --branch main
```
Once RTRTR is installed, you need to create a config file that suits your
needs. The example in [`etc/rtrtr.conf`] may be a good way to start. The
config file to use needs to be passed to RTRTR via the `-c` option:
```
rtrtr -c rtrtr.conf
```
[`etc/rtrtr.conf`]: https://github.com/NLnetLabs/rtrtr/blob/main/etc/rtrtr.conf
## Quick Start with Docker
To run RTRTR with Docker you will first need to create an `rtrtr.conf` file
somewhere on your host computer and make that available to the Docker container
when you run it. For example if your config file is in `/etc/rtrtr.conf` on the
host computer:
```bash
docker run -v /etc/rtrtr.conf:/etc/rtrtr.conf nlnetlabs/rtrtr -c /etc/rtrtr.conf
```
RTRTR will need network access to fetch and publish data according to the
configured units and targets respectively. Explaining Docker networking is beyond
the scope of this README, however below are a couple of examples to get you
started.
If you need an RTRTR unit to fetch data from a source port on the host you will
also need to give the Docker container access to the host network. For example
one way to do this is with `--net=host`:
```bash
docker run --net=host ...
```
_(where ... represents the rest of the arguments to pass to Docker and RTRTR)_
This will also cause any configured RTRTR target ports to be published on the
host network interface.
If you're not using `--net=host` you will need to tell Docker to expoee the
RTRTR target ports, either one by one using `-p`, or you can publish the default
ports exposed by the Docker container (and at the same time remap them to high
numbered ports) using `-P`. E.g.
```bash
docker run -p 8080:8080/tcp -p 9001:9001/tcp ...
```
Or:
```bash
docker run -P ...
```
You can verify which ports are exposed using the `docker ps` command which should
show something like this:
```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
146237ba9b4b nlnetlabs/rtrtr "/sbin/tini -- rtrtr…" 16 seconds ago Up 14 seconds 0.0.0.0:49154->8080/tcp, 0.0.0.0:49153->9001/tcp zealous_tesla
```
_(the output in this example shows the high-numbered port mapping that occurs when using `docker run -P`)_
Please refer to the comprehensive
[documentation](https://rtrtr.docs.nlnetlabs.nl/) to learn what works
best for you.