]> git.ipfire.org Git - thirdparty/FORT-validator.git/commitdiff
Merge branch rtrv1
authorpcarana <pc.moreno2099@gmail.com>
Tue, 8 Oct 2019 17:18:12 +0000 (12:18 -0500)
committerpcarana <pc.moreno2099@gmail.com>
Tue, 8 Oct 2019 17:18:12 +0000 (12:18 -0500)
1  2 
README.md
docs/_layouts/default.html
docs/index.md

diff --cc README.md
index 1b31e2988956ab2e181088600478862576888603,0f55aceab34452b80a66fdfb6b55e2f82701d1d2..356f8c24296c8f553bd8c44ca28723dbf30f6c0b
+++ b/README.md
@@@ -1,59 -1,9 +1,9 @@@
- # FORT
+ # FORT Validator
  
- An RPKI Validator and RTR Server.
+ An RPKI Validator and RTR Server, part of the [FORT project](https://www.fortproject.net).
  
- ## Installation
+ ## Documentation
  
- Dependencies:
+ FORT Validator's documentation (installation, usage, etc.) can be found at [https://nicmx.github.io/FORT-validator/](https://nicmx.github.io/FORT-validator/).
  
- 1. libcrypto ([LibreSSL](http://www.libressl.org/) or [OpenSSL](https://www.openssl.org/) >= 1.1)
- 2. [jansson](https://github.com/akheron/jansson)
- 3. [rsync](http://rsync.samba.org/)
- The validator is currently supported in *64-bit* OS. A 32-bit OS may face the [Year 2038 problem](https://en.wikipedia.org/wiki/Year_2038_problem) when handling dates at certificates.
- After all the dependencies are installed, run:
- ```
- ./autogen.sh
- ./configure
- make
- make install
- ```
- More documentation at [https://nicmx.github.io/FORT-validator/](https://nicmx.github.io/FORT-validator/).
- ## Usage
- Use the following command to run an RTR server that will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory `--tal`:
- ```
- fort \
-       --tal <path to your TAL files> \
-       --local-repository <path where you want to keep your local cache> \
-       --server.address <your intended RTR server address> \
-       --server.port <your intended RTR server port>
- ```
- Run Fort validator as standalone (perform validation and exit) and print ROAs to CSV file:
- ```
- fort \
-       --mode standalone \
-       --output.roa <path to output file in CSV format> \
-       --tal <path to your TAL files> \
-       --local-repository <path where you want to keep your local cache>
- ```
- Run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416):
- ```
- fort \
-       --slurm <path to a SLURM file> \
-       --tal <path to your TAL files> \
-       --local-repository <path where you want to keep your local cache> \
-       --server.address <your intended RTR server address> \
-       --server.port <your intended RTR server port>
- ```
- Visit the [Usage](https://nicmx.github.io/FORT-validator/doc/usage.html) section at the docs to know all the possible Fort configurations, these are some usage examples.
 -If you wish to generate the docs by yourself, visit the [docs directory](https://github.com/NICMx/FORT-validator/tree/master/docs).
++If you wish to generate the docs by yourself, visit the [docs directory](https://github.com/NICMx/FORT-validator/tree/master/docs).
Simple merge
diff --cc docs/index.md
index 1c19062fca1b229cb1685b5d68d4b5fb2873d798,ea96b992c4ad81971e520fc14458fe81611b2340..327837ddfb17d27f4aa19d74c3104dc674957d74
@@@ -10,4 -10,4 +10,4 @@@ FORT validator is an MIT-licensed RPKI 
  
  ## Status
  
- Version [{{ site.fort-latest-version }}](https://github.com/NICMx/FORT-validator/releases/tag/v{{ site.fort-latest-version }}){:target="_blank"} is the first official release! Don't forget to read the [docs](doc/index.html).
 -Version [{{ site.fort-latest-version }}](https://github.com/NICMx/FORT-validator/releases/tag/v{{ site.fort-latest-version }}){:target="_blank"} is the latest official release, includes RTR version 1 support and a considerable improvement in execution time.
++Version [{{ site.fort-latest-version }}](https://github.com/NICMx/FORT-validator/releases/tag/v{{ site.fort-latest-version }}){:target="_blank"} is the latest official release, includes RTR version 1 support and a considerable improvement in execution time.