Upgrade documentation (#25 & #23)

thalesgroup-cert · Feb 1, 2021 · a268930 · a268930
1 parent 995a129
commit a268930
Show file tree

Hide file tree

Showing 27 changed files with 219 additions and 187 deletions.
diff --git a/Watcher/docs/_build/doctrees/README.doctree b/Watcher/docs/_build/doctrees/README.doctree
diff --git a/Watcher/docs/_build/doctrees/environment.pickle b/Watcher/docs/_build/doctrees/environment.pickle
diff --git a/Watcher/docs/_build/doctrees/index.doctree b/Watcher/docs/_build/doctrees/index.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/data_leak_core.doctree b/Watcher/docs/_build/doctrees/modules/data_leak_core.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/dns_finder_core.doctree b/Watcher/docs/_build/doctrees/modules/dns_finder_core.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/site_monitoring_core.doctree b/Watcher/docs/_build/doctrees/modules/site_monitoring_core.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/site_monitoring_misp.doctree b/Watcher/docs/_build/doctrees/modules/site_monitoring_misp.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/site_monitoring_thehive.doctree b/Watcher/docs/_build/doctrees/modules/site_monitoring_thehive.doctree
diff --git a/Watcher/docs/_build/doctrees/modules/threats_watcher_core.doctree b/Watcher/docs/_build/doctrees/modules/threats_watcher_core.doctree
diff --git a/Watcher/docs/_build/html/README.html b/Watcher/docs/_build/html/README.html
@@ -3,9 +3,9 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
+  <meta charset="utf-8" />
 
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
   <title>Watcher Installation &mdash; Watcher 1.0.0 documentation</title>
 
@@ -16,7 +16,10 @@
 
 
 
+
+
 
+
 
 
 
@@ -29,7 +32,6 @@
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
         <script src="_static/doctools.js"></script>
-        <script src="_static/language_data.js"></script>
 
     <script type="text/javascript" src="_static/js/theme.js"></script>
 
@@ -51,7 +53,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> Watcher
+            <a href="index.html" class="icon icon-home"> Watcher
 
 
 
@@ -90,12 +92,16 @@
 <li class="toctree-l3"><a class="reference internal" href="#migrate">Migrate</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#create-admin-user">Create admin user</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#populate-your-database">Populate your database</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#important">Important</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#user-enrollment">User enrollment</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#add-email-notifications-subscriber">Add email notifications subscriber</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#add-your-rss-source-to-threats-detection">Add your RSS source to Threats Detection</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#add-your-rss-source-to-threats-detection">Add your RSS source to Threats Detection</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#how-to-use-rss-bridge-to-add-more-sources-from-facebook-googlesearch-youtube">How to use RSS-Bridge to add more sources from Facebook, GoogleSearch, YouTube…</a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="#static-configuration">Static configuration</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#production-settings-important">Production Settings [Important]</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#access-watcher-remotely-within-your-server-instance">Access Watcher remotely within your server instance</a></li>
@@ -116,7 +122,10 @@
 <li class="toctree-l3"><a class="reference internal" href="#archived-alerts">Archived Alerts</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#update-watcher">Update Watcher</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#update-watcher">Update Watcher</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#maintain-automatically-your-docker-images-up-to-date">Maintain automatically your Docker images up-to-date</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="#remove-the-database">Remove the database</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#useful-commands">Useful commands</a></li>
 </ul>
@@ -167,6 +176,8 @@
 
 
 
+
+
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
@@ -178,7 +189,7 @@
 
       <li class="wy-breadcrumbs-aside">
 
-            
+
             <a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
 
 
@@ -256,6 +267,12 @@ <h3>Populate your database<a class="headerlink" href="#populate-your-database" t
 </pre></div>
 </div>
 </div>
+<div class="section" id="important">
+<h3>Important<a class="headerlink" href="#important" title="Permalink to this headline">¶</a></h3>
+<p>The first time you run Watcher, you will not have any new threats on the homepage, this is normal.</p>
+<p>You just have to wait for Watcher to crawl the Internet.
+This will happen every 30 minutes.</p>
+</div>
 </div>
 <div class="section" id="configuration">
 <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
@@ -305,6 +322,22 @@ <h3>Add your RSS source to Threats Detection<a class="headerlink" href="#add-you
 <li><p>Fill <strong>Url</strong> text input.</p></li>
 <li><p>Click on <strong>SAVE</strong>.</p></li>
 </ul>
+<div class="section" id="how-to-use-rss-bridge-to-add-more-sources-from-facebook-googlesearch-youtube">
+<h4>How to use RSS-Bridge to add more sources from Facebook, GoogleSearch, YouTube…<a class="headerlink" href="#how-to-use-rss-bridge-to-add-more-sources-from-facebook-googlesearch-youtube" title="Permalink to this headline">¶</a></h4>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.com/RSS-Bridge/rss-bridge">RSS-Bridge</a> is, by default, configured with Twitter only, but users can use it for all <a class="reference external" href="https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges">other sources</a> like: <strong>Facebook</strong>, <strong>DuckDuckGo</strong>, <strong>GoogleSearch</strong>…</p>
+<ul>
+<li><p>To do such you need to add the new bridge needed in the <code class="docutils literal notranslate"><span class="pre">Watcher/Rss-bridge/whitelist.txt</span></code> file.</p></li>
+</ul>
+</li>
+</ul>
+<p>An RSS-Bridge source URL looks like this: <code class="docutils literal notranslate"><span class="pre">http://10.10.10.7/?action=display&amp;bridge=Twitter&amp;context=By+username&amp;u=tomchop_&amp;norep=on&amp;nopic=on&amp;noimg=on&amp;noimgscaling=on&amp;format=Mrss</span></code></p>
+<p>To add your own custom url, simply change the <code class="docutils literal notranslate"><span class="pre">bridge</span></code>, if necessary, with the associated parameters (just keep <code class="docutils literal notranslate"><span class="pre">http://10.10.10.7/</span></code> &amp; <code class="docutils literal notranslate"><span class="pre">format=Mrss</span></code>).</p>
+<p>You can test RSS-Bridge API with a public instance like this one: https://wtf.roflcopter.fr/rss-bridge/</p>
+<ul class="simple">
+<li><p>Example: https://wtf.roflcopter.fr/rss-bridge/?action=display&amp;bridge=Twitter&amp;context=By+username&amp;u=tomchop_&amp;norep=on&amp;nopic=on&amp;noimg=on&amp;noimgscaling=on&amp;format=Mrss</p></li>
+</ul>
+</div>
 </div>
 <div class="section" id="static-configuration">
 <h3>Static configuration<a class="headerlink" href="#static-configuration" title="Permalink to this headline">¶</a></h3>
@@ -481,6 +514,10 @@ <h2>Update Watcher<a class="headerlink" href="#update-watcher" title="Permalink
 <li><p>Pull the newer docker images: <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">up</span></code></p></li>
 </ul>
 <p>This will update Watcher, Rss-bridge and Searx.</p>
+<div class="section" id="maintain-automatically-your-docker-images-up-to-date">
+<h3>Maintain automatically your Docker images up-to-date<a class="headerlink" href="#maintain-automatically-your-docker-images-up-to-date" title="Permalink to this headline">¶</a></h3>
+<p>To get the latest features automatically, we <strong>strongly recommend</strong> that you keep all your images up-to-date, using a tool like <a class="reference external" href="https://github.com/pyouroboros/ouroboros">Ouroboros</a>.</p>
+</div>
 </div>
 <div class="section" id="remove-the-database">
 <h2>Remove the database<a class="headerlink" href="#remove-the-database" title="Permalink to this headline">¶</a></h2>
@@ -513,37 +550,29 @@ <h2>Useful commands<a class="headerlink" href="#useful-commands" title="Permalin
 
           </div>
           <footer>
-
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
-        <a href="modules/threats_watcher_core.html" class="btn btn-neutral float-right" title="Threats Watcher - Core Algorithm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to Watcher’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
-
+        <a href="modules/threats_watcher_core.html" class="btn btn-neutral float-right" title="Threats Watcher - Core Algorithm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to Watcher’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
-
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-
-        &copy; Copyright 
+        &#169; Copyright .
 
     </p>
   </div>
 
 
 
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 
     provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
-
         </div>
       </div>
 

diff --git a/Watcher/docs/_build/html/_sources/README.md.txt b/Watcher/docs/_build/html/_sources/README.md.txt
@@ -54,6 +54,12 @@ Use `populate_db` script:
     docker-compose run watcher bash
     python manage.py populate_db
 
+### Important
+The first time you run Watcher, you will not have any new threats on the homepage, this is normal.
+
+You just have to wait for Watcher to crawl the Internet.
+This will happen every 30 minutes.
+
 ## Configuration
 
 ### User enrollment 
@@ -98,6 +104,17 @@ Connect to the `/admin` page:
 - Fill **Url** text input.
 - Click on **SAVE**.
 
+#### How to use RSS-Bridge to add more sources from Facebook, GoogleSearch, YouTube...
+- [RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge) is, by default, configured with Twitter only, but users can use it for all [other sources](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges) like: **Facebook**, **DuckDuckGo**, **GoogleSearch**...
+     - To do such you need to add the new bridge needed in the `Watcher/Rss-bridge/whitelist.txt` file.
+
+An RSS-Bridge source URL looks like this: `http://10.10.10.7/?action=display&bridge=Twitter&context=By+username&u=tomchop_&norep=on&nopic=on&noimg=on&noimgscaling=on&format=Mrss`
+
+To add your own custom url, simply change the `bridge`, if necessary, with the associated parameters (just keep `http://10.10.10.7/` & `format=Mrss`).
+
+You can test RSS-Bridge API with a public instance like this one: https://wtf.roflcopter.fr/rss-bridge/
+- Example: https://wtf.roflcopter.fr/rss-bridge/?action=display&bridge=Twitter&context=By+username&u=tomchop_&norep=on&nopic=on&noimg=on&noimgscaling=on&format=Mrss
+
 ### Static configuration
 Most of the settings can be modify from the `/admin` page.
 
@@ -261,6 +278,9 @@ To update Watcher image please follow the instructions below:
 
 This will update Watcher, Rss-bridge and Searx.
 
+### Maintain automatically your Docker images up-to-date
+To get the latest features automatically, we **strongly recommend** that you keep all your images up-to-date, using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros).
+
 ## Remove the database
 
 You may want to **reset** your database entirely, in case of troubleshooting or other. To do this you need to remove the database stored in your host system and restart the instance:

diff --git a/Watcher/docs/_build/html/_static/basic.css b/Watcher/docs/_build/html/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -764,6 +764,7 @@ div.code-block-caption code {
 }
 
 table.highlighttable td.linenos,
+span.linenos,
 div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
     user-select: none;
 }

diff --git a/Watcher/docs/_build/html/_static/doctools.js b/Watcher/docs/_build/html/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -285,9 +285,10 @@ var Documentation = {
   initOnKeyListeners: function() {
     $(document).keydown(function(event) {
       var activeElementType = document.activeElement.tagName;
-      // don't navigate when in search box or textarea
+      // don't navigate when in search box, textarea, dropdown or button
       if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
-          && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
+          && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
+          && !event.shiftKey) {
         switch (event.keyCode) {
           case 37: // left
             var prevHref = $('link[rel="prev"]').prop('href');

diff --git a/Watcher/docs/_build/html/_static/language_data.js b/Watcher/docs/_build/html/_static/language_data.js
@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/Watcher/docs/_build/html/_static/pygments.css b/Watcher/docs/_build/html/_static/pygments.css
@@ -1,5 +1,10 @@
+pre { line-height: 125%; }
+td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
-.highlight  { background: #f8f8f8; }
+.highlight { background: #f8f8f8; }
 .highlight .c { color: #408080; font-style: italic } /* Comment */
 .highlight .err { border: 1px solid #FF0000 } /* Error */
 .highlight .k { color: #008000; font-weight: bold } /* Keyword */

diff --git a/Watcher/docs/_build/html/_static/searchtools.js b/Watcher/docs/_build/html/_static/searchtools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -59,10 +59,10 @@ var Search = {
   _pulse_status : -1,
 
   htmlToText : function(htmlString) {
-      var htmlElement = document.createElement('span');
-      htmlElement.innerHTML = htmlString;
-      $(htmlElement).find('.headerlink').remove();
-      docContent = $(htmlElement).find('[role=main]')[0];
+      var virtualDocument = document.implementation.createHTMLDocument('virtual');
+      var htmlElement = $(htmlString, virtualDocument);
+      htmlElement.find('.headerlink').remove();
+      docContent = htmlElement.find('[role=main]')[0];
       if(docContent === undefined) {
           console.warn("Content block not found. Sphinx search tries to obtain it " +
                        "via '[role=main]'. Could you check your theme or template.");

diff --git a/Watcher/docs/_build/html/genindex.html b/Watcher/docs/_build/html/genindex.html
@@ -3,9 +3,9 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
+  <meta charset="utf-8" />
 
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
   <title>Index &mdash; Watcher 1.0.0 documentation</title>
 
@@ -16,7 +16,10 @@
 
 
 
+
+
 
+
 
 
 
@@ -29,7 +32,6 @@
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
         <script src="_static/doctools.js"></script>
-        <script src="_static/language_data.js"></script>
 
     <script type="text/javascript" src="_static/js/theme.js"></script>
 
@@ -49,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> Watcher
+            <a href="index.html" class="icon icon-home"> Watcher
 
 
 
@@ -129,6 +131,8 @@
 
 
 
+
+
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
@@ -140,7 +144,7 @@
 
       <li class="wy-breadcrumbs-aside">
 
-            
+
 
       </li>
 
@@ -395,28 +399,25 @@ <h2 id="W">W</h2>
 
           </div>
           <footer>
-
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-
-        &copy; Copyright 
+        &#169; Copyright .
 
     </p>
   </div>
 
 
 
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 
     provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
-
         </div>
       </div>