From: Alberto Leiva Popper Date: Tue, 6 Apr 2021 17:54:20 +0000 (-0500) Subject: Documentation: Update status X-Git-Tag: v1.5.1~29 X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=080243b6f5fa931d06339e859e8440536e0c45f6;p=thirdparty%2FFORT-validator.git Documentation: Update status Also elaborates on some command line flag documentation that has changed since the last release. --- diff --git a/docs/index.md b/docs/index.md index c25f777a..5c143f24 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,6 +11,8 @@ FORT validator is an MIT-licensed RPKI Relying Party, this is a tool offered as ## Status +> Due to a temporary resource shortage, the project's development has slowed down to essential maintenance. No new features are expected to be developed during the first half of 2021 (at least), but bugfixing and support will remain active. + Version **{{ site.fort-latest-version }}** is the latest official release. To fetch or review it, visit the [GitHub release](https://github.com/NICMx/FORT-validator/releases/tag/v{{ site.fort-latest-version }}){:target="_blank"}. ## Quick start @@ -18,4 +20,4 @@ Version **{{ site.fort-latest-version }}** is the latest official release. To fe Probably you just want to read: - How to install? Visit [Compilation and Installation](installation.html). - How to execute? Visit [Basic Usage](run.html) and [Program Arguments](usage.html). -- How to configure the router(s)? Visit [Routers](routers.html). \ No newline at end of file +- How to configure the router(s)? Visit [Routers](routers.html). diff --git a/docs/usage.md b/docs/usage.md index d29ea6e7..fca8bc3b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -725,6 +725,18 @@ Otherwise, Fort will perform HTTP requests when needed (eg. an HTTPS URI at a TA - **Type:** String (Path to file) - **Availability:** `argv` and JSON +> Note: The paragraphs below apply to [Fort 1.5.0](https://github.com/NICMx/FORT-validator/releases/tag/v1.5.0). + +File where the ROAs will be stored in CSV format. + +When the file is specified, its content will be removed to store the ROAs; if the file doesn't exists, it will be created. To print at console, use a hyphen `"-"`. If RTR server is enabled, then the ROAs will be printed every [`--server.interval.validation`](#--serverintervalvalidation) secs. + +Each line of the result is printed in the following order: _AS, Prefix, Max prefix length_; the first line contains those column descriptors. + +If a value isn't specified, then the ROAs aren't printed. + +> Note: The paragraphs below apply to [Fort master](https://github.com/NICMx/FORT-validator). + File where the ROAs will be stored in the configured format (see [`--output.format`](#--outputformat)). When the file is specified, its content will be removed to store the ROAs; if the file doesn't exists, it will be created. To print at console, use a hyphen `"-"`. If RTR server is enabled, then the ROAs will be printed every [`--server.interval.validation`](#--serverintervalvalidation) secs. @@ -755,6 +767,20 @@ If a value isn't specified, then the ROAs aren't printed. - **Type:** String (Path to file) - **Availability:** `argv` and JSON +> Note: The paragraphs below apply to [Fort 1.5.0](https://github.com/NICMx/FORT-validator/releases/tag/v1.5.0). + +File where the BGPsec Router Keys will be stored in CSV format. + +Since most of the data is binary (Subject Key Identifier and Subject Public Key Info), such data is base64url encoded without trailing pads. + +When the file is specified, its content will be removed to store the Router Keys; if the file doesn't exists, it will be created. To print at console, use a hyphen `"-"`. If RTR server is enabled, then the BGPsec Router Keys will be printed every [`--server.interval.validation`](#--serverintervalvalidation) secs. + +Each line of the result is printed in the following order: _AS, Subject Key Identifier, Subject Public Key Info_; the first line contains those column descriptors. + +If a value isn't specified, then the BGPsec Router Keys aren't printed. + +> Note: The paragraphs below apply to [Fort master](https://github.com/NICMx/FORT-validator). + File where the BGPsec Router Keys will be stored in the configured format (see [`--output.format`](#--outputformat)). Since most of the data is binary (Subject Key Identifier and Subject Public Key Info), such data is base64url encoded without trailing pads. @@ -788,6 +814,8 @@ If a value isn't specified, then the BGPsec Router Keys aren't printed. - **Availability:** `argv` and JSON - **Default:** `csv` +> Note: This flag only exists in [Fort master](https://github.com/NICMx/FORT-validator). + Output format for [`--output.roa`](#--outputroa) and [`--output.bgpsec`](#--outputbgpsec). ### `--asn1-decode-max-stack`