searxng/annas_archive.html at gh-pages

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

 <!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>Anna’s Archive &#8212; SearXNG Documentation (2025.2.9+a1e2b2546)</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
     <script src="../../../_static/documentation_options.js?v=09da0b18"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script data-project="searxng" data-version="2025.2.9+a1e2b2546" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="Arch Linux" href="archlinux.html" />
     <link rel="prev" title="Alpine Linux Packages" href="alpinelinux.html" />
   </head><body>
     <div class="related" role="navigation" aria-label="Related">
       <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="archlinux.html" title="Arch Linux"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="alpinelinux.html" title="Alpine Linux Packages"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.2.9+a1e2b2546)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Anna’s Archive</a></li>
       </ul>
     </div>
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
           <div class="body" role="main">
   <section id="anna-s-archive">
 <span id="annas-archive-engine"></span><h1>Anna’s Archive<a class="headerlink" href="#anna-s-archive" title="Link to this heading">¶</a></h1>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
 <li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
 </ul>
 </nav>
 <p id="module-searx.engines.annas_archive"><a class="reference external" href="https://annas-archive.org/">Anna’s Archive</a> is a free non-profit online shadow library metasearch
 engine providing access to a variety of book resources (also via IPFS), created
 by a team of anonymous archivists (<a class="reference external" href="https://annas-software.org/AnnaArchivist/annas-archive">AnnaArchivist</a>).</p>
 <section id="configuration">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
 <p>The engine has the following additional settings:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_content" title="searx.engines.annas_archive.aa_content"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_content</span></code></a></p></li>
 <li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_ext" title="searx.engines.annas_archive.aa_ext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_ext</span></code></a></p></li>
 <li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_sort" title="searx.engines.annas_archive.aa_sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_sort</span></code></a></p></li>
 </ul>
 <p>With this options a SearXNG maintainer is able to configure <strong>additional</strong>
 engines for specific searches in Anna’s Archive.  For example a engine to search
 for <em>newest</em> articles and journals (PDF) / by shortcut <code class="docutils literal notranslate"><span class="pre">!aaa</span> <span class="pre">&lt;search-term&gt;</span></code>.</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">annas articles</span>
 <span class="w">  </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">annas_archive</span>
 <span class="w">  </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aaa</span>
 <span class="w">  </span><span class="nt">aa_content</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;magazine&#39;</span>
 <span class="w">  </span><span class="nt">aa_ext</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;pdf&#39;</span>
 <span class="w">  </span><span class="nt">aa_sort</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;newest&#39;</span>
 </pre></div>
 </div>
 </section>
 <section id="implementations">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
 </section>
 <dl class="py data">
 <dt class="sig sig-object py" id="searx.engines.annas_archive.aa_content">
 <span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_content</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><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.engines.annas_archive.aa_content" title="Link to this definition">¶</a></dt>
 <dd><p>Anan’s search form field <strong>Content</strong> / possible values:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">book_fiction</span><span class="p">,</span> <span class="n">book_unknown</span><span class="p">,</span> <span class="n">book_nonfiction</span><span class="p">,</span>
 <span class="n">book_comic</span><span class="p">,</span> <span class="n">magazine</span><span class="p">,</span> <span class="n">standards_document</span>
 </pre></div>
 </div>
 <p>To not filter use an empty string (default).</p>
 </dd></dl>
 <dl class="py data">
 <dt class="sig sig-object py" id="searx.engines.annas_archive.aa_sort">
 <span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_sort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><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.engines.annas_archive.aa_sort" title="Link to this definition">¶</a></dt>
 <dd><p>Sort Anna’s results, possible values:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">newest</span><span class="p">,</span> <span class="n">oldest</span><span class="p">,</span> <span class="n">largest</span><span class="p">,</span> <span class="n">smallest</span>
 </pre></div>
 </div>
 <p>To sort by <em>most relevant</em> use an empty string (default).</p>
 </dd></dl>
 <dl class="py data">
 <dt class="sig sig-object py" id="searx.engines.annas_archive.aa_ext">
 <span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_ext</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><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.engines.annas_archive.aa_ext" title="Link to this definition">¶</a></dt>
 <dd><p>Filter Anna’s results by a file ending.  Common filters for example are
 <code class="docutils literal notranslate"><span class="pre">pdf</span></code> and <code class="docutils literal notranslate"><span class="pre">epub</span></code>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Anna’s Archive is a beta release: Filter results by file extension does not
 really work on Anna’s Archive.</p>
 </div>
 </dd></dl>
 <dl class="py function">
 <dt class="sig sig-object py" id="searx.engines.annas_archive.init">
 <span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/annas_archive.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.annas_archive.init" title="Link to this definition">¶</a></dt>
 <dd><p>Check of engine’s settings.</p>
 </dd></dl>
 <dl class="py function">
 <dt class="sig sig-object py" id="searx.engines.annas_archive.fetch_traits">
 <span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/annas_archive.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.annas_archive.fetch_traits" title="Link to this definition">¶</a></dt>
 <dd><p>Fetch languages and other search arguments from Anna’s search form.</p>
 </dd></dl>
 </section>
             <div class="clearer"></div>
           </div>
         </div>
       </div>
   <span id="sidebar-top"></span>
       <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
             <p class="logo"><a href="../../../index.html">
               <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
             </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 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../rtm_asdf.html">Runtime Management</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../extended_types.html">Extended Types</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
 <li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
 <li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
 <li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
 <li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
 <li class="toctree-l5 current"><a class="current reference internal" href="#">Anna’s Archive</a></li>
 <li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
 <li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
 <li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
 <li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
 <li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
 <li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
 <li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
 <li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
 <li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
 <li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
 <li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
 <li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
 <li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
 <li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
 <li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
 <li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
 <li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
 <li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
 <li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
 <li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
 <li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
 <li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
 <li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
 <li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
 <li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
 <li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
 <li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
 </ul>
 </li>
 <li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../plugins/index.html">Plugins</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../lxcdev.html">Developing in Linux Containers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></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">Developer documentation</a>
         <ul>
       <li><a href="../index.html">Engine Implementations</a>
         <ul>
           <li>Previous: <a href="alpinelinux.html" title="previous chapter">Alpine Linux Packages</a>
           <li>Next: <a href="archlinux.html" title="next chapter">Arch Linux</a></ul>
       </li></ul>
       </li>
     </ul>
   </li>
 </ul>
 <search 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>
 </search>
 <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/dev/engines/online/annas_archive.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
         </div>
       </div>
       <div class="clearer"></div>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright SearXNG team.
     </div>
   </body>
 </html>