Merge pull request #628 from kvch/gh-pages

simplify index page of docs

_sources/dev/install/installation.txt

@@ -1,3 +1,5 @@
+.. _installation:
+
 Installation
 ============
 

_sources/index.txt

@@ -1,22 +1,25 @@
 Welcome to searx
 ================
 
-Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
+Search without being tracked.
 
+Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.
+
+Get started with searx by using one of the `public instances`_. If you don't trust anyone, you can set up your own, see :ref:`installation`.
+
+.. _public instances: https://github.com/asciimoo/searx/wiki/Searx-instances
 
 Features
 --------
 
  - Self hosted
- - Does not track its users
- - Does not share its users data with third parties
- - Does not use cookies by default
- - Does not profile its users
- - Does not collect its users data
- - Offers secure, encrypted connections (HTTPS/SSL)
- - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
+ - No user tracking
+ - No user profiling
  - About 70 supported search engines
- - Easy intergration with any search engine
+ - Easy intergration with any search engines
+ - Cookies are not used by default
+ - Secure, encrypted connections (HTTPS/SSL)
+ - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
 
 
 User documentation

dev/install/installation.html

@@ -40,7 +40,7 @@
           <div class="body" role="main">
             
   <div class="section" id="installation">
-<h1><a class="toc-backref" href="#id2">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<span id="id1"></span><h1><a class="toc-backref" href="#id3">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
 <p>Step by step installation for Debian/Ubuntu with virtualenv.</p>
 <p>Source: <a class="reference external" href="https://about.okhin.fr/posts/Searx/">https://about.okhin.fr/posts/Searx/</a> with some additions</p>
 <p>How to: <a class="reference external" href="https://www.reddit.com/r/privacytoolsIO/comments/366kvn/how_to_setup_your_own_privacy_respecting_search/">Setup searx in a couple of hours with a free SSL
@@ -48,24 +48,24 @@ certificate</a></p>
 <div class="contents topic" id="contents">
 <p class="topic-title first">Contents</p>
 <ul class="simple">
-<li><a class="reference internal" href="#installation" id="id2">Installation</a><ul>
-<li><a class="reference internal" href="#basic-installation" id="id3">Basic installation</a></li>
-<li><a class="reference internal" href="#configuration" id="id4">Configuration</a></li>
-<li><a class="reference internal" href="#check" id="id5">Check</a></li>
-<li><a class="reference internal" href="#uwsgi" id="id6">uwsgi</a></li>
-<li><a class="reference internal" href="#web-server" id="id7">Web server</a><ul>
-<li><a class="reference internal" href="#with-nginx" id="id8">with nginx</a></li>
-<li><a class="reference internal" href="#with-apache" id="id9">with apache</a></li>
+<li><a class="reference internal" href="#installation" id="id3">Installation</a><ul>
+<li><a class="reference internal" href="#basic-installation" id="id4">Basic installation</a></li>
+<li><a class="reference internal" href="#configuration" id="id5">Configuration</a></li>
+<li><a class="reference internal" href="#check" id="id6">Check</a></li>
+<li><a class="reference internal" href="#uwsgi" id="id7">uwsgi</a></li>
+<li><a class="reference internal" href="#web-server" id="id8">Web server</a><ul>
+<li><a class="reference internal" href="#with-nginx" id="id9">with nginx</a></li>
+<li><a class="reference internal" href="#with-apache" id="id10">with apache</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#how-to-update" id="id10">How to update</a></li>
-<li><a class="reference internal" href="#docker" id="id11">Docker</a></li>
+<li><a class="reference internal" href="#how-to-update" id="id11">How to update</a></li>
+<li><a class="reference internal" href="#docker" id="id12">Docker</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="basic-installation">
-<h2><a class="toc-backref" href="#id3">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id4">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>
 <p>For Ubuntu, be sure to have enable universe repository.</p>
 <p>Install packages:</p>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">git</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">python</span><span class="o">-</span><span class="n">pybabel</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="n">libffi</span><span class="o">-</span><span class="n">dev</span> <span class="n">libssl</span><span class="o">-</span><span class="n">dev</span>
@@ -88,14 +88,14 @@ certificate</a></p>
 </div>
 </div>
 <div class="section" id="configuration">
-<h2><a class="toc-backref" href="#id4">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id5">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s">&quot;s/ultrasecretkey/`openssl rand -hex 16`/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
 </pre></div>
 </div>
 <p>Edit searx/settings.yml if necessary.</p>
 </div>
 <div class="section" id="check">
-<h2><a class="toc-backref" href="#id5">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id6">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>
 <p>Start searx:</p>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
 </pre></div>
@@ -110,7 +110,7 @@ certificate</a></p>
 twice).</p>
 </div>
 <div class="section" id="uwsgi">
-<h2><a class="toc-backref" href="#id6">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id7">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>
 <p>Install packages:</p>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">uwsgi</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">plugin</span><span class="o">-</span><span class="n">python</span>
 </pre></div>
@@ -153,9 +153,9 @@ this content:</p>
 </div>
 </div>
 <div class="section" id="web-server">
-<h2><a class="toc-backref" href="#id7">Web server</a><a class="headerlink" href="#web-server" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id8">Web server</a><a class="headerlink" href="#web-server" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="with-nginx">
-<h3><a class="toc-backref" href="#id8">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id9">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>
 <p>If nginx is not installed (uwsgi will not work with the package
 nginx-light):</p>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nginx</span>
@@ -238,7 +238,7 @@ location @searx {
 </div>
 </div>
 <div class="section" id="with-apache">
-<h3><a class="toc-backref" href="#id9">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id10">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>
 <p>Add wsgi mod:</p>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libapache2</span><span class="o">-</span><span class="n">mod</span><span class="o">-</span><span class="n">uwsgi</span>
 <span class="n">sudo</span> <span class="n">a2enmod</span> <span class="n">uwsgi</span>
@@ -259,8 +259,8 @@ change <code class="docutils literal"><span class="pre">&lt;Location</span> <spa
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
 </pre></div>
 </div>
-<div class="section" id="id1">
-<h4>disable logs<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
+<div class="section" id="id2">
+<h4>disable logs<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
 <p>For better privacy you can disable Apache logs.</p>
 <p>WARNING: not tested</p>
 <p>WARNING: you can only disable logs for the whole (virtual) server not
@@ -277,7 +277,7 @@ for a specific path.</p>
 </div>
 </div>
 <div class="section" id="how-to-update">
-<h2><a class="toc-backref" href="#id10">How to update</a><a class="headerlink" href="#how-to-update" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id11">How to update</a><a class="headerlink" href="#how-to-update" title="Permalink to this headline">¶</a></h2>
 <div class="code sh highlight-default"><div class="highlight"><pre><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
 <span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
@@ -290,7 +290,7 @@ for a specific path.</p>
 </div>
 </div>
 <div class="section" id="docker">
-<h2><a class="toc-backref" href="#id11">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id12">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>
 <p>Make sure you have installed Docker. For instance, you can deploy searx like this:</p>
 <div class="code sh highlight-default"><div class="highlight"><pre>docker pull wonderfall/searx
 docker run -d --name searx -p $PORT:8888 wonderfall/searx

docs/dev/install/installation.rst

@@ -1,3 +1,5 @@
+.. _installation:
+
 Installation
 ============
 

docs/index.rst

@@ -1,22 +1,25 @@
 Welcome to searx
 ================
 
-Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
+Search without being tracked.
 
+Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.
+
+Get started with searx by using one of the `public instances`_. If you don't trust anyone, you can set up your own, see :ref:`installation`.
+
+.. _public instances: https://github.com/asciimoo/searx/wiki/Searx-instances
 
 Features
 --------
 
  - Self hosted
- - Does not track its users
- - Does not share its users data with third parties
- - Does not use cookies by default
- - Does not profile its users
- - Does not collect its users data
- - Offers secure, encrypted connections (HTTPS/SSL)
- - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
+ - No user tracking
+ - No user profiling
  - About 70 supported search engines
- - Easy intergration with any search engine
+ - Easy intergration with any search engines
+ - Cookies are not used by default
+ - Secure, encrypted connections (HTTPS/SSL)
+ - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
 
 
 User documentation

index.html

@@ -40,21 +40,21 @@
             
   <div class="section" id="welcome-to-searx">
 <h1>Welcome to searx<a class="headerlink" href="#welcome-to-searx" title="Permalink to this headline">¶</a></h1>
-<p>Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
+<p>Search without being tracked.</p>
+<p>Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.</p>
+<p>Get started with searx by using one of the <a class="reference external" href="https://github.com/asciimoo/searx/wiki/Searx-instances">public instances</a>. If you don&#8217;t trust anyone, you can set up your own, see <a class="reference internal" href="dev/install/installation.html#installation"><span class="std std-ref">Installation</span></a>.</p>
 <div class="section" id="features">
 <h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><ul class="simple">
 <li>Self hosted</li>
-<li>Does not track its users</li>
-<li>Does not share its users data with third parties</li>
-<li>Does not use cookies by default</li>
-<li>Does not profile its users</li>
-<li>Does not collect its users data</li>
-<li>Offers secure, encrypted connections (HTTPS/SSL)</li>
-<li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
+<li>No user tracking</li>
+<li>No user profiling</li>
 <li>About 70 supported search engines</li>
-<li>Easy intergration with any search engine</li>
+<li>Easy intergration with any search engines</li>
+<li>Cookies are not used by default</li>
+<li>Secure, encrypted connections (HTTPS/SSL)</li>
+<li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
 </ul>
 </div></blockquote>
 </div>

user/search_syntax.html

@@ -25,7 +25,7 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="next" title="Installation" href="../dev/install/installation.html" />
-    <link rel="prev" title="Privacy-respecting free metasearch engine" href="../index.html" />
+    <link rel="prev" title="Welcome to searx" href="../index.html" />
    
   
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />