Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nlnetlabs/routinator-ui
A user interface for Routinator
https://github.com/nlnetlabs/routinator-ui
routinator rpki
Last synced: about 1 month ago
JSON representation
A user interface for Routinator
- Host: GitHub
- URL: https://github.com/nlnetlabs/routinator-ui
- Owner: NLnetLabs
- License: mpl-2.0
- Created: 2020-12-01T12:12:31.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T09:31:06.000Z (3 months ago)
- Last Synced: 2024-11-13T01:10:06.889Z (about 1 month ago)
- Topics: routinator, rpki
- Language: TypeScript
- Homepage: https://nlnetlabs.nl/rpki
- Size: 919 KB
- Stars: 7
- Watchers: 10
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Routinator user interface
## About
User Interface for [Routinator](https://nlnetlabs.nl/projects/rpki/routinator/).
Routinator 3000 is free, open source RPKI Relying Party software written in the Rust programming language. The application is designed to be secure and have great portability. It is a lightweight implementation that can run effortlessly on almost any operating system using minimalist hardware.
Routinator is a full-featured RPKI Relying Party software package that runs as a service which periodically downloads and verifies RPKI data. Routers can connect to Routinator to fetch verified data via the RPKI-to-Router (RTR) protocol. The built-in HTTP server offers a user interface and API endpoints for the various file formats, as well as logging, status and Prometheus metrics.
The user interface allows users to validate prefixes against ASNs found in BGP announcements. Next to that it allows users to lookup related prefixes for the prefix they're searching for. These related prefixes can be more- or less-specific prefixes, routed in BGP or prefixes that are allocated by one of the five Regional Internet Registries.
## Architecture
This SPA front-end application is written using only one dependency, namely [React](https://reactjs.org/).
## Requirements
Install a recent version of [yarn](https://yarnpkg.com/).
## Run in development
```sh
yarn
yarn dev
```
Navigate to [http://localhost:5173](http://localhost:5173).
Example search: http://localhost:5173/?prefix=104.154.0.0%2F15&validate-bgp=true
## Build for production
```sh
yarn
yarn build
```
Note that small [images are inlined](https://vitejs.dev/guide/assets) in scripts
or stylesheets for performance reasons.
The resulting `index.html` will include static assets using absolute paths.
By default the assets are included from `/assets/*`. Change this path using
the `--assetsDir` option, see [the build oprtions](https://vitejs.dev/guide/cli.html#options-1);
To change the path prefix, specify the `--base` option during a build, e.g.:
```sh
yarn build --base /static
```
In that case assets will be included from `/static/assets/*`,
but the output directory structure wil not change.
See [the documentation on base](https://vitejs.dev/config/shared-options.html#base);
## Linting
```sh
yarn lint
```
## Formatting
```sh
yarn format
```
## Unit tests
```sh
yarn test
```
## Resources
## Specify API hosts
The API hosts to use can be specified at runtime or at build time. By default
the current host is used for the Routinator API endpoints and https://rest.bgp-api.net
for the Roto API.
By specifying `ROTO_API_HOST` and/or `ROUTINATOR_API_HOST` as environment variables
these can be configured at build time. For example:
```sh
ROTO_API_HOST=https://rest.bgp-api.net ROUTINATOR_API_HOST=https://routinator.nlnetlabs.nl yarn build
```
## Endpoint documentation
* https://routinator.docs.nlnetlabs.nl/en/stable/monitoring.html
* https://routinator.docs.nlnetlabs.nl/en/stable/json-metrics.html