Update docs structure and content, merge with master.

author pcarana <pc.moreno2099@gmail.com>

Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)

committer pcarana <pc.moreno2099@gmail.com>

Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)
author pcarana <pc.moreno2099@gmail.com>
Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)
committer pcarana <pc.moreno2099@gmail.com>
Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)
diff --git a/README.md b/README.md

index 32ee19f381ef0418d89d3dc117db24655e39dff1..bb113077eb68a9c9ef6a7ecd7cd7f4297b8c1799 100644 (file)
--- 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 <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>
  ```
  
-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 28c701813e0795b2ee62c5af76fbbd501bf3ec4b..fbc8a4d076731069d7c55719dc054fd9e47cf7c8 100644 (file)
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -10,10 +10,9 @@
         <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css">
  
         <!-- Styles -->
-       <link href="{% if page.url == '/' %}./css/screen.css{% else %}../css/screen.css{% endif %}" rel="stylesheet" type="text/css">
+       <link href="./css/screen.css" rel="stylesheet" type="text/css">
  
-       <!-- Site is still under construction, so don't index it -->
-       <meta name="robots" content="noindex,nofollow">
+       <meta name="robots" content="index,follow">
  </head>
  
  <body>
@@ -23,15 +22,9 @@
                 <div class="row align-items-center">
                         <div class="col">
                                 <div class="logo">
-                                       {% if page.url == '/' %}
-                                               <a href="./index.html" title="" class="d-flex">
-                                                       <img src="./img/logo_validador_fort.svg" alt="Fort" width="125px">
-                                               </a>
-                                       {% else %}
-                                               <a href="../index.html" title="" class="d-flex">
-                                                       <img src="../img/logo_validador_fort.svg" alt="Fort" width="125px">
-                                               </a>
-                                       {% endif %}
+                                       <a href="./index.html" title="" class="d-flex">
+                                               <img src="./img/logo_validador_fort.svg" alt="Fort" width="125px">
+                                       </a>
                                 </div>
                         </div>
                         <div class="col-auto">
@@ -43,21 +36,9 @@
                                 <div class="navigation">
                                         <nav class="site-nav">
                                                 <ul>
-                                                       {% if page.url == '/' %}
-                                                               <li>
-                                                                       <a class="active-item" href="./index.html">Home</a>
-                                                               </li>
-                                                               <li>
-                                                                       <a href="./doc/index.html">Documentation</a>
-                                                               </li>
-                                                       {% else %}
-                                                               <li>
-                                                                       <a href="../index.html">Home</a>
-                                                               </li>
-                                                               <li><a class="active-item" href="./index.html">Documentation</a>
-                                                               </li>
-                                                       {% endif %}
-
+                                                       <li>
+                                                               <a class="active-item" href="./index.html">FORT Validator</a>
+                                                       </li>
                                                 </ul>
                                         </nav>
  
@@ -70,36 +51,36 @@
  <section class="site-section section-h-full">
         <div class="container">
                 <div class="row">
-                       {% if (page.url.size} > 5 %}
                         <div class="col-lg-3">
                                 <aside class="site-aside">
                                         <ul class="list-bullet">
-
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/intro-rpki.html' %} active{% endif %}" href="intro-rpki.html">Introduction to RPKI</a>
+                                                       <a class="item-menu{% if page.url == '/' or page.url == '/index.html' %} active{% endif %}" href="index.html">Home</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/intro-fort.html' %} active{% endif %}" href="intro-fort.html">Introduction to Fort</a>
+                                                       <a class="item-menu{% if page.url == '/intro-rpki.html' %} active{% endif %}" href="intro-rpki.html">Introduction to RPKI</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/installation.html' %} active{% endif %}" href="installation.html">Compilation and Installation</a>
+                                                       <a class="item-menu{% if page.url == '/intro-fort.html' %} active{% endif %}" href="intro-fort.html">Introduction to Fort</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/run.html' %} active{% endif %}" href="run.html">Running Fort</a>
+                                                       <a class="item-menu{% if page.url == '/installation.html' %} active{% endif %}" href="installation.html">Compilation and Installation</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/usage.html' %} active{% endif %}" href="usage.html">Fort usage</a>
+                                                       <a class="item-menu{% if page.url == '/run.html' %} active{% endif %}" href="run.html">Running Fort</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/slurm.html' %} active{% endif %}" href="slurm.html">SLURM</a>
+                                                       <a class="item-menu{% if page.url == '/usage.html' %} active{% endif %}" href="usage.html">Fort usage</a>
                                                 </li>
                                                 <li>
-                                                       <a class="item-menu{% if page.url == '/doc/incidence.html' %} active{% endif %}" href="incidence.html">Incidences</a>
+                                                       <a class="item-menu{% if page.url == '/slurm.html' %} active{% endif %}" href="slurm.html">SLURM</a>
+                                               </li>
+                                               <li>
+                                                       <a class="item-menu{% if page.url == '/incidence.html' %} active{% endif %}" href="incidence.html">Incidences</a>
                                                 </li>
                                         </ul>
                                 </aside>
                         </div>
-                       {% endif %}
                         <div class="col">
                                 <article class="article-section">
                                 {{ content }}
@@ -111,12 +92,17 @@
  <!-- Footer -->
  <footer class="site-footer">
         <div class="container">
-               <div class="row">
+               <div class="row align-items-center">
+                       <div class="col">
+                       </div>
                         <div class="col">
                                 <a href="https://github.com/NICMx/FORT-validator" target="_blank" title="" class="d-flex justify-content-center">
-                                       <img src="{% if page.url == '/' %}./img/GitHub-Mark-Light-120px-plus.png{% else %}../img/GitHub-Mark-Light-120px-plus.png{% endif %}" alt="Git" width="40">
+                                       <img src="./img/GitHub-Mark-Light-120px-plus.png" alt="Git" width="40">
                                 </a>
                         </div>
+                       <div class="col-lg text-right">
+                               <a href="mailto:fort-validator@nic.mx" target="_blank" title="">fort-validator@nic.mx</a>
+                       </div>
                 </div>
         </div>
  </footer>
@@ -129,7 +115,7 @@
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"></script>
  
  <!-- APP JS -->
-<script src="{% if page.url == '/' %}./js/metodos.js{% else %}../js/metodos.js{% endif %}" type="text/javascript"></script>
+<script src="./js/metodos.js" type="text/javascript"></script>
  
  
  </body>
diff --git a/docs/doc/index.md b/docs/doc/index.md

deleted file mode 100644 (file)

index 0dd1f81..0000000
--- 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 (file)

index b04aded..0000000
--- 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 <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>
-{% endhighlight %}
-
-See [usage](usage.html) for more details.
diff --git a/docs/img/chain.svg b/docs/img/chain.svg

index 6bc7589c12a5a9d0281843c9d1e55f242405a2d7..4321d37054080c0af4381de609e9c3f23bffab5a 100644 (file)
--- 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">
    <defs
       id="defs2">
@@ -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 @@
          <dc:format>image/svg+xml</dc:format>
          <dc:type
             rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
+        <dc:title />
        </cc:Work>
      </rdf:RDF>
    </metadata>
@@ -223,19 +223,19 @@
         width="100%"
         height="100%" />
      <rect
-       style="display:inline;fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.39687499;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-       id="rect5663"
-       width="35.983345"
-       height="74.083336"
-       x="253.99998"
-       y="205.98335" />
-    <rect
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.39687499;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       style="fill-opacity:1;stroke:#000000;stroke-width:0.39687499;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;fill:#ffffff;opacity:1"
         id="rect5735"
         width="40.216652"
         height="78.316673"
         x="251.88333"
         y="203.86668" />
+    <rect
+       style="display:inline;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.39687499;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       id="rect5663"
+       width="35.983345"
+       height="74.083336"
+       x="253.99998"
+       y="205.98335" />
      <text
         xml:space="preserve"
         style="font-style:normal;font-weight:normal;font-size:5.64444447px;line-height:1.25;font-family:sans-serif;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
diff --git a/docs/img/tree.svg b/docs/img/tree.svg

index 6deb960251659c884419764287933ebfcb7824a8..2e4499a97e34a93b71cdcc8e4d451974c7762611 100644 (file)
--- a/docs/img/tree.svg
+++ b/docs/img/tree.svg
@@ -15,7 +15,7 @@
     viewBox="0 0 193.67502 107.94999"
     version="1.1"
     id="svg8"
-   inkscape:version="0.92.3 (2405546, 2018-03-11)"
+   inkscape:version="0.92.4 (unknown)"
     sodipodi:docname="tree.svg">
    <defs
       id="defs2">
@@ -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 @@
          <dc:format>image/svg+xml</dc:format>
          <dc:type
             rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
+        <dc:title />
        </cc:Work>
      </rdf:RDF>
    </metadata>
@@ -747,6 +747,222 @@
         transform="translate(99.483333)"
         width="100%"
         height="100%" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 10.655,380.0164 v -21.375 H 23.99875 37.3425 v 21.375 21.375 H 23.99875 10.655 Z"
+       id="path1049"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 8.6550004,380.0164 v -23.375 H 23.99875 39.3425 v 23.375 23.375 H 23.99875 8.6550004 Z m 29.9999996,0 v -22.625 H 23.99875 9.3425004 v 22.58333 c 0,12.42084 0.01875,22.60209 0.041667,22.625 0.022917,0.0229 6.6182286,0.0417 14.6562496,0.0417 H 38.655 Z"
+       id="path1052"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 46.654999,380.0164 v -21.375 h 13.34375 13.34375 v 21.375 21.375 h -13.34375 -13.34375 z"
+       id="path1054"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 44.655,380.0164 v -23.375 h 15.343749 15.34375 v 23.375 23.375 H 59.998749 44.655 Z m 29.999999,0 v -22.625 H 59.998749 45.3425 v 22.58333 c 0,12.42084 0.01875,22.60209 0.04167,22.625 0.02292,0.0229 6.618229,0.0417 14.65625,0.0417 h 14.614583 z"
+       id="path1057"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 82.6175,380.0164 v -21.375 H 95.992499 109.3675 v 21.375 21.375 H 95.992499 82.6175 Z"
+       id="path1059"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 80.6175,380.0164 v -23.375 H 95.992499 111.3675 v 23.375 23.375 H 95.992499 80.6175 Z m 30,0 v -22.625 H 95.992499 81.3675 v 22.625 22.625 H 95.992499 110.6175 Z"
+       id="path1061"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 130.63,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 H 144.005 130.63 Z"
+       id="path1063"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 128.63,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 H 144.005 128.63 Z m 30,0 v -22.625 H 144.005 129.38 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1065"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 164.63,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 H 180.005 164.63 Z m 30,0 v -22.625 H 180.005 165.38 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1067"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 166.63,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 H 180.005 166.63 Z"
+       id="path1069"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 202.6175,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1071"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 200.6175,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1073"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 250.6325,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1075"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 248.6325,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1077"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 284.6325,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1079"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 286.6325,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1081"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 322.6325,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1083"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 320.6325,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1085"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 384.6,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 H 399.975 384.6 Z m 30,0 v -22.625 H 399.975 385.35 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1087"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 386.6,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 H 399.975 386.6 Z"
+       id="path1089"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 420.6,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 H 435.975 420.6 Z m 30,0 v -22.625 H 435.975 421.35 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1091"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 422.6,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 H 435.975 422.6 Z"
+       id="path1093"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 458.62,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 H 471.995 458.62 Z"
+       id="path1095"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 456.62,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 H 471.995 456.62 Z m 30,0 v -22.625 H 471.995 457.37 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1097"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 506.6075,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1099"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 504.6075,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1101"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 540.6075,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1103"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 542.6075,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1105"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 578.6475,380.0164 v -21.375 h 13.375 13.375 v 21.375 21.375 h -13.375 -13.375 z"
+       id="path1107"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 576.6475,380.0164 v -23.375 h 15.375 15.375 v 23.375 23.375 h -15.375 -15.375 z m 30,0 v -22.625 h -14.625 -14.625 v 22.625 22.625 h 14.625 14.625 z"
+       id="path1109"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 626.625,380.0164 v -21.375 H 640 653.375 v 21.375 21.375 H 640 626.625 Z"
+       id="path1111"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 624.625,380.0164 v -23.375 H 640 655.375 v 23.375 23.375 H 640 624.625 Z m 30,0 v -22.625 H 640 625.375 v 22.625 22.625 H 640 654.625 Z"
+       id="path1113"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 662.625,380.0164 v -21.375 H 676 689.375 v 21.375 21.375 H 676 662.625 Z"
+       id="path1115"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 660.625,380.0164 v -23.375 H 676 691.375 v 23.375 23.375 H 676 660.625 Z m 30,0 v -22.625 H 676 661.375 v 22.625 22.625 H 676 690.625 Z"
+       id="path1117"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 698.66,380.0164 v -21.375 h 13.34375 13.34375 v 21.375 21.375 H 712.00375 698.66 Z"
+       id="path1119"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
+    <path
+       style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.23625;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 696.66,380.0164 v -23.375 h 15.34375 15.34375 v 23.375 23.375 H 712.00375 696.66 Z m 29.96875,0 v -22.59375 l -14.64062,-0.0157 -14.64063,-0.0158 v 22.62526 22.62526 l 14.64063,-0.0158 14.64062,-0.0158 z"
+       id="path1121"
+       inkscape:connector-curvature="0"
+       transform="matrix(0.26458333,0,0,0.26458333,0,189.05003)" />
    </g>
    <g
       inkscape:groupmode="layer"
diff --git a/docs/doc/incidence.md b/docs/incidence.md

similarity index 98%

rename from docs/doc/incidence.md

rename to docs/incidence.md

index e084139b78040761c6d71161216edd008ce7168e..5749ca20055defe65e894e17f5e067f2d4aaa05a 100644 (file)
--- a/docs/doc/incidence.md
+++ b/docs/incidence.md
@@ -2,8 +2,6 @@
  title: Incidence
  ---
   
-[Documentation](index.html) > {{ page.title }}
-
  # {{ page.title }} 
  
  ## Index
diff --git a/docs/index.md b/docs/index.md

index 1c19062fca1b229cb1685b5d68d4b5fb2873d798..e6e8172fd829cefa672ca34bb46d728d48f410d8 100644 (file)
--- 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 7aabae744a48bbae0cb89f1719018d0082b256c9..8661bc00831db3ece2f8310cf1d5b9fd447f8314 100644 (file)
--- 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 ac52d73110c7577241bfc91e407c0ad79adaa436..1c9146583cbe7eeef410a093ca3662fc6210381d 100644 (file)
--- 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 94e7cd2db685b8b7f2f4bcd7a8e5b6c421db3bf5..ddbc57c2929008c94ad2013340e5808dca94625f 100644 (file)
--- 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 (file)

index 0000000..27a48c3
--- /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 <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>
+{% 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 <path to output file in CSV format> \
+       --tal <path to your TAL files> \
+       --local-repository <path where you want to keep your local cache>
+{% endhighlight %}
+
+This will run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416):
+
+{% highlight bash %}
+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>
+{% 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 f4c18431d3fbc7a9f5c7d7451af7cc9f478d1a03..1810c63929efa0d39bbe3d8acbff275075c397a7 100644 (file)
--- 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 bbd551d47269f443e11b053505306c4584f79742..8a2db419fda41e0d29cb62e4371c30b316fccec0 100644 (file)
--- 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
author	pcarana <pc.moreno2099@gmail.com>
	Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)
committer	pcarana <pc.moreno2099@gmail.com>
	Mon, 9 Sep 2019 19:02:00 +0000 (14:02 -0500)
README.md		patch \| blob \| blame \| history
docs/_layouts/default.html		patch \| blob \| blame \| history
docs/doc/index.md	[deleted file]	patch \| blob \| blame \| history
docs/doc/run.md	[deleted file]	patch \| blob \| blame \| history
docs/img/chain.svg		patch \| blob \| blame \| history
docs/img/tree.svg		patch \| blob \| blame \| history
docs/incidence.md	[moved from docs/doc/incidence.md with 98% similarity]	patch \| blob \| blame \| history
docs/index.md		patch \| blob \| blame \| history
docs/installation.md	[moved from docs/doc/installation.md with 99% similarity]	patch \| blob \| blame \| history
docs/intro-fort.md	[moved from docs/doc/intro-fort.md with 98% similarity]	patch \| blob \| blame \| history
docs/intro-rpki.md	[moved from docs/doc/intro-rpki.md with 96% similarity]	patch \| blob \| blame \| history
docs/run.md	[new file with mode: 0644]	patch \| blob
docs/slurm.md	[moved from docs/doc/slurm.md with 99% similarity]	patch \| blob \| blame \| history
docs/usage.md	[moved from docs/doc/usage.md with 99% similarity]	patch \| blob \| blame \| history