Add 'Quick Start' paragraph and some usage examples of --init-tals

diff --git a/README.md b/README.md
index eb3016e2c19163b2e6d6ac82469548453f246cde..f6d977ea86dd5b3159610203eeacb5a8c15989e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,4 +10,11 @@ If you wish to generate the docs by yourself, visit the [docs directory](docs/).
 
 ## Docker image
 
-A Dockerfile to build the image is located at the [docker directory](docker/).
\ No newline at end of file
+A Dockerfile to build the image is located at the [docker directory](docker/).
+
+## Quick start
+
+TL;DR all the docs, probably you just want to read:
+- How to install? Visit [Compilation and Installation](https://nicmx.github.io/FORT-validator/installation.html).
+- How to execute? Visit [Basic Usage](https://nicmx.github.io/FORT-validator/run.html) and [Program Arguments](https://nicmx.github.io/FORT-validator/usage.html).
+- How to configure the router(s)? Visit [Routers](https://nicmx.github.io/FORT-validator/routers.html).

diff --git a/docs/index.md b/docs/index.md
index f316b75c96c80560ee357a5b49bd7941cd41dfb0..c25f777a36364681de4add94053ea8269ebe02d8 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -11,4 +11,11 @@ FORT validator is an MIT-licensed RPKI Relying Party, this is a tool offered as
 
 ## Status
 
-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"}.
\ No newline at end of file
+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
+
+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

diff --git a/docs/installation.md b/docs/installation.md
index 4ee4c3c16dffa9819d46c31e46c379297c7a8c9e..6de323d907738bfad2ed5f2ffef7bd19d06a43ce 100644 (file)
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -8,12 +8,11 @@ description: Guide to compile and install FORT Validator.
 ## Index
 
 1. [Dependencies](#dependencies)
-2. [Setup script](#setup-script)
-3. [Option 1: Installing the package](#option-1-installing-the-package)
+2. [Option 1: Installing the package](#option-1-installing-the-package)
        1. [Debian package](#debian-package)
        2. [Gentoo package](#gentoo-package)
        3. [RHEL/CentOS package](#rhelcentos-package)
-4. [Option 2: Compiling and installing the release tarball](#option-2-compiling-and-installing-the-release-tarball)
+3. [Option 2: Compiling and installing the release tarball](#option-2-compiling-and-installing-the-release-tarball)
        1. [Debian version](#debian-version)
        2. [OpenBSD version](#openbsd-version)
        3. [RHEL/CentOS version](#rhelcentos-version)
@@ -23,8 +22,11 @@ description: Guide to compile and install FORT Validator.
        7. [Slackware version](#slackware-version)
        8. [Gentoo version](#gentoo-version)
        9. [Alpine version](#alpine-version)
-5. [Option 3: Compiling and installing the git repository](#option-3-compiling-and-installing-the-git-repository)
-6. [Option 4: Running from a Docker container](#option-4-running-from-a-docker-container)
+4. [Option 3: Compiling and installing the git repository](#option-3-compiling-and-installing-the-git-repository)
+5. [Option 4: Running from a Docker container](#option-4-running-from-a-docker-container)
+6. [Fetching the TALs](#fetching-the-tals)
+       1. [`--init-tals` argument](#--init-tals-argument)
+       2. [Setup script](#setup-script)
 
 ## Dependencies
 
@@ -40,31 +42,6 @@ The dependencies are
 
 Fort 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, and currently there's no work around for this.
 
-## Setup script
-
-> ![img/warn.svg](img/warn.svg) This script exists merely to ease the ARIN TAL download (and some other additional stuff), it isn't a prerequisite to compile or run FORT validator, although we strongly advise to fetch ARIN TAL (using this script or by other means) in order to get the whole RPKI validated by FORT validator.
-
-The script can be found [here](https://github.com/NICMx/FORT-validator/blob/v{{ site.fort-latest-version }}/fort_setup.sh). It only expects one argument: an _existent directory path_ where the 5 RIRs TALS will be downloaded.
-
-Basically, it does the following:
-1. Display message to agree ARIN RPA.
-2. If agreed, download ARIN TAL to the received arg (named `TALS_PATH` from now on).
-3. Download the rest of the TALs to `TALS_PATH`.
-4. Try to create directory `/var/cache/fort/repository`, on error create `/tmp/fort/repository`.
-5. Create configuration file with [`tal`](https://nicmx.github.io/FORT-validator/usage.html#--tal) and [`local-repository`](https://nicmx.github.io/FORT-validator/usage.html#--local-repository) members, with a value of `TALS_PATH` (absolute path) and the directory path created at the previous step.
-6. Display FORT validator execution examples:
-  - Using the created configuration file (uses the arg [`-f`](https://nicmx.github.io/FORT-validator/usage.html#--configuration-file)).
-  - Using the values of the configuration file (uses the args [`--tal`](https://nicmx.github.io/FORT-validator/usage.html#--tal) and [`--local-repository`](https://nicmx.github.io/FORT-validator/usage.html#--local-repository)).
-
-Preferably, run this script with the same user what will run FORT validator. It's recommended that the user has write permission in `/var/cache`, since the script will try to create a directory there ([see more](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch05s05.html)). Here's an execution example:
-
-{% highlight bash %}
-# Get the script
-wget https://raw.githubusercontent.com/NICMx/FORT-validator/v{{ site.fort-latest-version }}/fort_setup.sh
-mkdir ~/tal
-./fort_setup.sh ~/tal
-{% endhighlight %}
-
 ## Option 1: Installing the package
 
 ### Debian package
@@ -88,11 +65,10 @@ sudo apt install ./fort_{{ site.fort-latest-version }}-1_amd64.deb
 > 
 > `deb http://ftp.mx.debian.org/debian buster main`
 
-This version ships with 4 of the 5 TALs, so in order to get the missing one, the [Setup script](#setup-script) can be executed using the argument `/etc/fort/tal`:
+This version ships with 4 of the 5 TALs, so in order to get the missing one, the [`--init-tals` argument](#--init-tals-argument) can be utilized using also the argument `--tal=/etc/fort/tal`:
 
 {% highlight bash %}
-# Assuming that the script is at the current location and the script was already downloaded
-sudo ./fort_setup.sh /etc/fort/tal
+sudo fort --init-tals --tal=/etc/fort/tal
 # Don't forget to restart fort service
 sudo service fort restart
 {% endhighlight %}
@@ -197,11 +173,10 @@ wget https://github.com/NICMx/FORT-validator/releases/download/v{{ site.fort-lat
 sudo yum install fort-{{ site.fort-latest-version }}-1.el8.x86_64.rpm
 {% endhighlight %}
 
-This version ships with 4 of the 5 TALs, so in order to get the missing one, the [Setup script](#setup-script) can be executed using the argument `/etc/fort/tal`:
+This version ships with 4 of the 5 TALs, so in order to get the missing one, the [`--init-tals` argument](#--init-tals-argument) can be utilized using also the argument `--tal=/etc/fort/tal`:
 
 {% highlight bash %}
-# Assuming that the script is at the current location and the script was already downloaded
-sudo ./fort_setup.sh /etc/fort/tal
+sudo fort --init-tals --tal=/etc/fort/tal
 {% endhighlight %}
 
 By default, FORT validator service isn't initialized once it's installed; so, initialize the service:
@@ -456,4 +431,43 @@ A basic example to run the container using the default values, reading from a lo
 docker run --name fort-validator -v host/path/to/tals:/etc/fort/tal:ro -p 8323:323 -d fort-validator
 {% endhighlight %}
 
-Read more about the Docker container at the Github repository [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker).
\ No newline at end of file
+Read more about the Docker container at the Github repository [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker).
+
+## Fetching the TALs
+
+Once FORT validator is installed and ready to run, you should have the TAL files from the 5 RIRs. You can obtain them one by one from each RIR, or also you can use the following options.
+
+### `--init-tals` argument
+
+Probably this is a more straight forward approach, since you only need to run Fort binary using the [`--init-tals`](usage.html#--init-tals) argument:
+
+{% highlight bash %}
+fort --init-tals --tal /etc/fort/tal
+{% endhighlight %}
+
+See more about this argument at [Program Arguments - `--init-tals`](usage.html#--init-tals).
+
+### Setup script
+
+> ![img/warn.svg](img/warn.svg) This script exists merely to ease the ARIN TAL download (and some other additional stuff), it isn't a prerequisite to compile or run FORT validator, although we strongly advise to fetch ARIN TAL (using this script or by other means) in order to get the whole RPKI validated by FORT validator.
+
+The script can be found [here](https://github.com/NICMx/FORT-validator/blob/v{{ site.fort-latest-version }}/fort_setup.sh). It only expects one argument: an _existent directory path_ where the 5 RIRs TALS will be downloaded.
+
+Basically, it does the following:
+1. Display message to agree ARIN RPA.
+2. If agreed, download ARIN TAL to the received arg (named `TALS_PATH` from now on).
+3. Download the rest of the TALs to `TALS_PATH`.
+4. Try to create directory `/var/cache/fort/repository`, on error create `/tmp/fort/repository`.
+5. Create configuration file with [`tal`](https://nicmx.github.io/FORT-validator/usage.html#--tal) and [`local-repository`](https://nicmx.github.io/FORT-validator/usage.html#--local-repository) members, with a value of `TALS_PATH` (absolute path) and the directory path created at the previous step.
+6. Display FORT validator execution examples:
+  - Using the created configuration file (uses the arg [`-f`](https://nicmx.github.io/FORT-validator/usage.html#--configuration-file)).
+  - Using the values of the configuration file (uses the args [`--tal`](https://nicmx.github.io/FORT-validator/usage.html#--tal) and [`--local-repository`](https://nicmx.github.io/FORT-validator/usage.html#--local-repository)).
+
+Preferably, run this script with the same user what will run FORT validator. It's recommended that the user has write permission in `/var/cache`, since the script will try to create a directory there ([see more](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch05s05.html)). Here's an execution example:
+
+{% highlight bash %}
+# Get the script
+wget https://raw.githubusercontent.com/NICMx/FORT-validator/v{{ site.fort-latest-version }}/fort_setup.sh
+mkdir ~/tal
+./fort_setup.sh ~/tal
+{% endhighlight %}
\ No newline at end of file

diff --git a/docs/run.md b/docs/run.md
index 384692a80d28594436d0d15288ed427899a75c6c..df5e74d6299c6a7548d987ab35ae524779fea6d4 100644 (file)
--- a/docs/run.md
+++ b/docs/run.md
@@ -5,11 +5,15 @@ description: This is probably all you need, an RTR server will serve the ROAs re
 
 # {{ page.title }}
 
-This is probably all you need: fetch the RIR TALs and then start 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`:
+First you'll need the TAL files. If you don't have them already, you can execute Fort validator using the argument [`--init-tals`](usage.html#--init-tals):
 
 {% highlight bash %}
 fort --init-tals --tal <path to store TAL files>
+{% endhighlight %}
+
+Now, this is probably all you need, an RTR server will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory [`--tal`](usage.html#--tal):
 
+{% highlight bash %}
 fort \
        --tal <path to your TAL files> \
        --local-repository <path where you want to keep your local cache> \

diff --git a/docs/usage.md b/docs/usage.md
index fc2caf389751599c50671ba25fa417fe4fde0bc4..5da82f5a4ae8cdbd30c758ca35c198adae255072 100644 (file)
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -224,7 +224,11 @@ This argument exists merely to have all TALs before running FORT validator, the
 
 By default, the 4 TALs that don't require a policy acceptance are downloaded from FORT validator's GitHub repository. ARIN TAL does require an explicit acceptance by the user, so it's downloaded only after the user accepts ARIN's RPA; this message is displayed at the terminal and only if the user accepts, ARIN TAL is also downloaded.
 
-This is an example on how to use this argument (assuming that `/etc/fort/tal` exists and is writable): `fort --init-tals --tal /etc/fort/tal`
+This is an example on how to use this argument (assuming that `/etc/fort/tal` exists and is writable):
+
+{% highlight bash %}
+$ {{ page.command }} --init-tals --tal /etc/fort/tal
+{% endhighlight %}
 
 ### `--tal`