<!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 > Architecture — 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 = "List of plugins" href = "plugins.html" / >
< link rel = "prev" title = "Administration API" href = "api.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 = "plugins.html" title = "List of plugins"
accesskey = "N" > next< / a > |< / li >
< li class = "right" >
< a href = "api.html" title = "Administration API"
accesskey = "P" > previous< / a > |< / li >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > SearXNG Documentation (2025.2.9+a1e2b2546)< / a > » < / li >
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Administrator documentation< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Architecture< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section id = "architecture" >
< span id = "id1" > < / span > < h1 > Architecture< a class = "headerlink" href = "#architecture" title = "Link to this heading" > ¶< / a > < / h1 >
< aside class = "sidebar" >
< p class = "sidebar-title" > Further reading< / p >
< ul class = "simple" >
< li > < p > Reverse Proxy: < a class = "reference internal" href = "installation-apache.html#apache-searxng-site" > < span class = "std std-ref" > Apache< / span > < / a > & < a class = "reference internal" href = "installation-nginx.html#nginx-searxng-site" > < span class = "std std-ref" > nginx< / span > < / a > < / p > < / li >
< li > < p > uWSGI: < a class = "reference internal" href = "installation-uwsgi.html#searxng-uwsgi" > < span class = "std std-ref" > uWSGI< / span > < / a > < / p > < / li >
< li > < p > SearXNG: < a class = "reference internal" href = "installation-searxng.html#installation-basic" > < span class = "std std-ref" > Step by step installation< / span > < / a > < / p > < / li >
< / ul >
< / aside >
< p > Herein you will find some hints and suggestions about typical architectures of
SearXNG infrastructures.< / p >
< section id = "uwsgi-setup" >
< span id = "architecture-uwsgi" > < / span > < h2 > uWSGI Setup< a class = "headerlink" href = "#uwsgi-setup" title = "Link to this heading" > ¶< / a > < / h2 >
< p > We start with a < em > reference< / em > setup for public SearXNG instances which can be build
up and maintained by the scripts from our < a class = "reference internal" href = "../utils/index.html#toolboxing" > < span class = "std std-ref" > DevOps tooling box< / span > < / a > .< / p >
< figure class = "align-default" id = "id2" >
< img alt = "arch_public.dot" src = "../_images/arch_public.svg" / >
< figcaption >
< p > < span class = "caption-number" > Fig. 2 < / span > < span class = "caption-text" > Reference architecture of a public SearXNG setup.< / span > < a class = "headerlink" href = "#id2" title = "Link to this image" > ¶< / a > < / p >
< / figcaption >
< / figure >
< p > The reference installation activates < code class = "docutils literal notranslate" > < span class = "pre" > server.limiter< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > server.image_proxy< / span > < / code >
and < code class = "docutils literal notranslate" > < span class = "pre" > ui.static_use_hash< / span > < / code > (< a class = "extlink-origin reference external" href = "https://github.com/searxng/searxng/blob/master/utils/templates/etc/searxng/settings.yml" > /etc/searxng/settings.yml< / a > )< / p >
< div class = "highlight-yaml notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # SearXNG settings< / span >
< span class = "nt" > use_default_settings< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > true< / span >
< span class = "nt" > general< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "nt" > debug< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > false< / span >
< span class = "w" > < / span > < span class = "nt" > instance_name< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s" > " SearXNG" < / span >
< span class = "nt" > search< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "nt" > safe_search< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > 2< / span >
< span class = "w" > < / span > < span class = "nt" > autocomplete< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s" > ' duckduckgo' < / span >
< span class = "nt" > server< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "c1" > # Is overwritten by ${SEARXNG_SECRET}< / span >
< span class = "w" > < / span > < span class = "nt" > secret_key< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s" > " ultrasecretkey" < / span >
< span class = "w" > < / span > < span class = "nt" > limiter< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > true< / span >
< span class = "w" > < / span > < span class = "nt" > image_proxy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > true< / span >
< span class = "w" > < / span > < span class = "c1" > # public URL of the instance, to ensure correct inbound links. Is overwritten< / span >
< span class = "w" > < / span > < span class = "c1" > # by ${SEARXNG_URL}.< / span >
< span class = "w" > < / span > < span class = "c1" > # base_url: http://example.com/location< / span >
< span class = "nt" > redis< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "c1" > # URL to connect redis database. Is overwritten by ${SEARXNG_REDIS_URL}.< / span >
< span class = "w" > < / span > < span class = "nt" > url< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > unix:///usr/local/searxng-redis/run/redis.sock?db=0< / span >
< span class = "nt" > ui< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "nt" > static_use_hash< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l l-Scalar l-Scalar-Plain" > true< / span >
< / pre > < / div >
< / div >
< / section >
< / 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 current" > < a class = "reference internal" href = "index.html" > Administrator documentation< / a > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings/index.html" > Settings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation.html" > Installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-docker.html" > Docker Container< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-scripts.html" > Installation Script< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-searxng.html" > Step by step installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-uwsgi.html" > uWSGI< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-nginx.html" > NGINX< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation-apache.html" > Apache< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "update-searxng.html" > SearXNG maintenance< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "answer-captcha.html" > Answer CAPTCHA from server’ s IP< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "searx.favicons.html" > Favicons< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "searx.limiter.html" > Limiter< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api.html" > Administration API< / a > < / li >
< li class = "toctree-l2 current" > < a class = "current reference internal" href = "#" > Architecture< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#uwsgi-setup" > uWSGI Setup< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "plugins.html" > List of plugins< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "buildhosts.html" > Buildhosts< / a > < / li >
< / ul >
< / 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" > < 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" > Administrator documentation< / a >
< ul >
< li > Previous: < a href = "api.html" title = "previous chapter" > Administration API< / a >
< li > Next: < a href = "plugins.html" title = "next chapter" > List of plugins< / a > < / 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/admin/architecture.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 >
< / body >
< / html >