<!DOCTYPE html> <html lang="en" data-content_root="../"> <head> <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"> <title>Tor check plugin — SearXNG Documentation (2023.12.31+3535377c9)</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" /> <link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" /> <link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" /> <script src="../_static/documentation_options.js?v=b1d9d925"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Redis DB" href="searx.redisdb.html" /> <link rel="prev" title="Locales" href="searx.locales.html" /> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="searx.redisdb.html" title="Redis DB" accesskey="N">next</a> |</li> <li class="right" > <a href="searx.locales.html" title="Locales" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2023.12.31+3535377c9)</a> »</li> <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Source-Code</a> »</li> <li class="nav-item nav-item-this"><a href="">Tor check plugin</a></li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <section id="tor-check-plugin"> <span id="id1"></span><h1>Tor check plugin<a class="headerlink" href="#tor-check-plugin" title="Link to this heading">¶</a></h1> <p id="module-searx.plugins.tor_check">A plugin to check if the ip address of the request is a Tor exit-node if the user searches for <code class="docutils literal notranslate"><span class="pre">tor-check</span></code>. It fetches the tor exit node list from <a class="reference external" href="https://check.torproject.org/exit-addresses">https://check.torproject.org/exit-addresses</a> and parses all the IPs into a list, then checks if the user’s IP address is in it.</p> <p>Enable in <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>:</p> <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">enabled_plugins</span><span class="p">:</span> <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">..</span> <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">- 'Tor check plugin'</span> </pre></div> </div> <dl class="py data"> <dt class="sig sig-object py" id="searx.plugins.tor_check.description"> <span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'This</span> <span class="pre">plugin</span> <span class="pre">checks</span> <span class="pre">if</span> <span class="pre">the</span> <span class="pre">address</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">request</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">Tor</span> <span class="pre">exit-node,</span> <span class="pre">and</span> <span class="pre">informs</span> <span class="pre">the</span> <span class="pre">user</span> <span class="pre">if</span> <span class="pre">it</span> <span class="pre">is;</span> <span class="pre">like</span> <span class="pre">check.torproject.org,</span> <span class="pre">but</span> <span class="pre">from</span> <span class="pre">SearXNG.'</span></em><a class="headerlink" href="#searx.plugins.tor_check.description" title="Link to this definition">¶</a></dt> <dd><p>Translated description of the plugin.</p> </dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="searx.plugins.tor_check.name"> <span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Tor</span> <span class="pre">check</span> <span class="pre">plugin'</span></em><a class="headerlink" href="#searx.plugins.tor_check.name" title="Link to this definition">¶</a></dt> <dd><p>Translated name of the plugin</p> </dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="searx.plugins.tor_check.preference_section"> <span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">preference_section</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'query'</span></em><a class="headerlink" href="#searx.plugins.tor_check.preference_section" title="Link to this definition">¶</a></dt> <dd><p>The preference section where the plugin is shown.</p> </dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="searx.plugins.tor_check.query_examples"> <span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">query_examples</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.plugins.tor_check.query_examples" title="Link to this definition">¶</a></dt> <dd><p>Query examples shown in the preferences.</p> </dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="searx.plugins.tor_check.query_keywords"> <span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">query_keywords</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['tor-check']</span></em><a class="headerlink" href="#searx.plugins.tor_check.query_keywords" title="Link to this definition">¶</a></dt> <dd><p>Query keywords shown in the preferences.</p> </dd></dl> </section> <div class="clearer"></div> </div> </div> </div> <span id="sidebar-top"></span> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="../index.html"> <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo"/> </a></p> <h3><a href="../index.html">Table of Contents</a></h3> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li> <li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li> <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../utils/index.html">DevOps tooling box</a></li> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Source-Code</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="searx.babel_extract.html">Custom message extractor (i18n)</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.botdetection.html">Bot Detection</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.exceptions.html">SearXNG Exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="searx.locales.html">Locales</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Tor check plugin</a><ul> <li class="toctree-l3"><a class="reference internal" href="#searx.plugins.tor_check.description"><code class="docutils literal notranslate"><span class="pre">description</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#searx.plugins.tor_check.name"><code class="docutils literal notranslate"><span class="pre">name</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#searx.plugins.tor_check.preference_section"><code class="docutils literal notranslate"><span class="pre">preference_section</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#searx.plugins.tor_check.query_examples"><code class="docutils literal notranslate"><span class="pre">query_examples</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#searx.plugins.tor_check.query_keywords"><code class="docutils literal notranslate"><span class="pre">query_keywords</span></code></a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="searx.redisdb.html">Redis DB</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.redislib.html">Redis Library</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.search.html">Search</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.search.processors.html">Search processors</a></li> <li class="toctree-l2"><a class="reference internal" href="searx.utils.html">Utility functions for the engines</a></li> </ul> </li> </ul> <h3>Project Links</h3> <ul> <li><a href="https://github.com/searxng/searxng/tree/master">Source</a> <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a> <li><a href="https://searx.space">Public instances</a> <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a> </ul><h3>Navigation</h3> <ul> <li><a href="../index.html">Overview</a> <ul> <li><a href="index.html">Source-Code</a> <ul> <li>Previous: <a href="searx.locales.html" title="previous chapter">Locales</a> <li>Next: <a href="searx.redisdb.html" title="next chapter">Redis DB</a></ul> </li> </ul> </li> </ul> <div id="searchbox" style="display: none" role="search"> <h3 id="searchlabel">Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <input type="submit" value="Go" /> </form> </div> </div> <script>document.getElementById('searchbox').style.display = "block"</script> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/src/searx.plugins.tor_check.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> </div> </div> <div class="clearer"></div> </div> <div class="footer" role="contentinfo"> © Copyright SearXNG team. </div> <script src="../_static/version_warning_offset.js"></script> </body> </html>