From: pcarana Date: Mon, 9 Sep 2019 19:02:00 +0000 (-0500) Subject: Update docs structure and content, merge with master. X-Git-Tag: v1.1.0~1^2~7 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=70939988a2bf45ecb8d16b67600cedc5cf2d6f3a;p=thirdparty%2FFORT-validator.git Update docs structure and content, merge with master. -Bring the last updates from master (from commit 298c8f9ab0147159e70e47fb7f0766a5bc1b8b31). -Fix background of some images (use white instead of none). -Remove the 'doc' dir and move all its content to root folder, so that the whole documentation can be consulted from the root directory. -Update the documentation index. -Update docs layout references to match the new directory structure. --- diff --git a/README.md b/README.md index 32ee19f3..bb113077 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,35 @@ More documentation at [https://nicmx.github.io/FORT-validator/](https://nicmx.gi ## 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 \ + --local-repository \ + --server.address \ + --server.port +``` + +Run Fort validator as standalone (perform validation and exit) and print ROAs to CSV file: + +``` +fort \ + --mode standalone \ + --output.roa \ + --tal \ + --local-repository +``` + +Run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416): + ``` fort \ + --slurm \ --tal \ --local-repository \ --server.address \ --server.port ``` -An RTR server will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory `--tal`. +Visit the [Usage](https://nicmx.github.io/FORT-validator/usage.html) section at the docs to know all the possible Fort configurations, these are some usage examples. \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 28c70181..fbc8a4d0 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -10,10 +10,9 @@ - + - - + @@ -23,15 +22,9 @@
@@ -43,21 +36,9 @@
@@ -70,36 +51,36 @@
- {% if (page.url.size} > 5 %}
- {% endif %}
{{ content }} @@ -111,12 +92,17 @@ @@ -129,7 +115,7 @@ - + diff --git a/docs/doc/index.md b/docs/doc/index.md deleted file mode 100644 index 0dd1f817..00000000 --- a/docs/doc/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Documentation Index ---- - -# {{ page.title }} - -1. [Introduction to RPKI](intro-rpki.html) -2. [Introduction to Fort](intro-fort.html) -3. [Compilation and Installation](installation.html) -4. [Running Fort](run.html) -5. [Fort usage](usage.html) -6. [SLURM](slurm.html) -7. [Incidences](incidence.html) diff --git a/docs/doc/run.md b/docs/doc/run.md deleted file mode 100644 index b04adede..00000000 --- a/docs/doc/run.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Running Fort ---- - -[Documentation](index.html) > {{ page.title }} - -# {{ page.title }} - -This is probably all you need: - -{% highlight bash %} -fort \ - --tal \ - --local-repository \ - --server.address \ - --server.port -{% endhighlight %} - -See [usage](usage.html) for more details. diff --git a/docs/img/chain.svg b/docs/img/chain.svg index 6bc7589c..4321d370 100644 --- a/docs/img/chain.svg +++ b/docs/img/chain.svg @@ -15,7 +15,7 @@ viewBox="0 0 294.21664 101.6" version="1.1" id="svg8" - inkscape:version="0.92.3 (2405546, 2018-03-11)" + inkscape:version="0.92.4 (unknown)" sodipodi:docname="chain.svg"> @@ -43,7 +43,7 @@ inkscape:pageopacity="0.0" inkscape:pageshadow="2" inkscape:zoom="1" - inkscape:cx="534.25773" + inkscape:cx="1066.4646" inkscape:cy="169.95574" inkscape:document-units="mm" inkscape:current-layer="layer1" @@ -52,7 +52,7 @@ inkscape:window-width="1920" inkscape:window-height="1015" inkscape:window-x="0" - inkscape:window-y="0" + inkscape:window-y="40" inkscape:window-maximized="1" inkscape:snap-object-midpoints="true" inkscape:snap-others="true" @@ -78,7 +78,7 @@ image/svg+xml - + @@ -223,19 +223,19 @@ width="100%" height="100%" /> - + @@ -208,9 +208,9 @@ borderopacity="1.0" inkscape:pageopacity="0.0" inkscape:pageshadow="2" - inkscape:zoom="1.4142136" - inkscape:cx="379.80632" - inkscape:cy="231.24197" + inkscape:zoom="16" + inkscape:cx="706.1475" + inkscape:cy="21.071098" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="true" @@ -218,7 +218,7 @@ inkscape:window-width="1920" inkscape:window-height="1015" inkscape:window-x="0" - inkscape:window-y="0" + inkscape:window-y="40" inkscape:window-maximized="1" inkscape:snap-object-midpoints="true" inkscape:snap-others="true" @@ -245,7 +245,7 @@ image/svg+xml - + @@ -747,6 +747,222 @@ transform="translate(99.483333)" width="100%" height="100%" /> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {{ page.title }} - # {{ page.title }} ## Index diff --git a/docs/index.md b/docs/index.md index 1c19062f..e6e8172f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,8 +6,8 @@ title: Home ## Introduction -The documentation can be found [here](doc/index.html). +FORT validator is an MIT-licensed RPKI Relying Party, this is a tool offered as part of the [FORT project](https://www.fortproject.net/). It is a service that performs the validation of the entire RPKI repository, and which serves the resulting ROAs for easy access by your routers. ## 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 first official release! \ No newline at end of file diff --git a/docs/doc/installation.md b/docs/installation.md similarity index 99% rename from docs/doc/installation.md rename to docs/installation.md index 7aabae74..8661bc00 100644 --- a/docs/doc/installation.md +++ b/docs/installation.md @@ -2,8 +2,6 @@ title: Compilation and Installation --- -[Documentation](index.html) > {{ page.title }} - # {{ page.title }} ## Index diff --git a/docs/doc/intro-fort.md b/docs/intro-fort.md similarity index 98% rename from docs/doc/intro-fort.md rename to docs/intro-fort.md index ac52d731..1c914658 100644 --- a/docs/doc/intro-fort.md +++ b/docs/intro-fort.md @@ -2,8 +2,6 @@ title: Introduction to Fort --- -[Documentation](index.html) > {{ page.title }} - # {{ page.title }} ## Design diff --git a/docs/doc/intro-rpki.md b/docs/intro-rpki.md similarity index 96% rename from docs/doc/intro-rpki.md rename to docs/intro-rpki.md index 94e7cd2d..ddbc57c2 100644 --- a/docs/doc/intro-rpki.md +++ b/docs/intro-rpki.md @@ -2,8 +2,6 @@ title: Introduction to RPKI --- -[Documentation](index.html) > {{ page.title }} - # {{ page.title }} ## Problem Statement diff --git a/docs/run.md b/docs/run.md new file mode 100644 index 00000000..27a48c31 --- /dev/null +++ b/docs/run.md @@ -0,0 +1,38 @@ +--- +title: Running Fort +--- + +# {{ page.title }} + +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`: + +{% highlight bash %} +fort \ + --tal \ + --local-repository \ + --server.address \ + --server.port +{% endhighlight %} + +This will run Fort validator as standalone (perform validation and exit) and print ROAs to CSV file: + +{% highlight bash %} +fort \ + --mode standalone \ + --output.roa \ + --tal \ + --local-repository +{% endhighlight %} + +This will run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416): + +{% highlight bash %} +fort \ + --slurm \ + --tal \ + --local-repository \ + --server.address \ + --server.port +{% endhighlight %} + +These are some examples to run Fort with distinct configurations; see [usage](usage.html) for more details. \ No newline at end of file diff --git a/docs/doc/slurm.md b/docs/slurm.md similarity index 99% rename from docs/doc/slurm.md rename to docs/slurm.md index f4c18431..1810c639 100644 --- a/docs/doc/slurm.md +++ b/docs/slurm.md @@ -2,8 +2,6 @@ title: SLURM --- -[Documentation](index.html) > {{ page.title }} - # {{ page.title }} ## Introduction diff --git a/docs/doc/usage.md b/docs/usage.md similarity index 99% rename from docs/doc/usage.md rename to docs/usage.md index bbd551d4..8a2db419 100644 --- a/docs/doc/usage.md +++ b/docs/usage.md @@ -3,8 +3,6 @@ title: Fort Usage command: fort --- -[Documentation](index.html) > {{ page.title }} - # {{ page.title }} ## Index