settings_server.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. _settings server:
  2. ===========
  3. ``server:``
  4. ===========
  5. .. code:: yaml
  6. server:
  7. base_url: http://example.org/location # change this!
  8. port: 8888
  9. bind_address: "127.0.0.1"
  10. secret_key: "ultrasecretkey" # change this!
  11. limiter: false
  12. image_proxy: false
  13. default_http_headers:
  14. X-Content-Type-Options : nosniff
  15. X-XSS-Protection : 1; mode=block
  16. X-Download-Options : noopen
  17. X-Robots-Tag : noindex, nofollow
  18. Referrer-Policy : no-referrer
  19. ``base_url`` : ``$SEARXNG_URL`` :ref:`buildenv <make buildenv>`
  20. The base URL where SearXNG is deployed. Used to create correct inbound links.
  21. If you change the value, don't forget to rebuild instance's environment
  22. (:ref:`utils/brand.env <make buildenv>`)
  23. ``port`` & ``bind_address``: ``$SEARXNG_PORT`` & ``$SEARXNG_BIND_ADDRESS`` :ref:`buildenv <make buildenv>`
  24. Port number and *bind address* of the SearXNG web application if you run it
  25. directly using ``python searx/webapp.py``. Doesn't apply to a SearXNG
  26. services running behind a proxy and using socket communications. If you
  27. change the value, don't forget to rebuild instance's environment
  28. (:ref:`utils/brand.env <make buildenv>`)
  29. ``secret_key`` : ``$SEARXNG_SECRET``
  30. Used for cryptography purpose.
  31. ``limiter`` :
  32. Rate limit the number of request on the instance, block some bots. The
  33. :ref:`limiter` requires a :ref:`settings redis` database.
  34. .. _image_proxy:
  35. ``image_proxy`` :
  36. Allow your instance of SearXNG of being able to proxy images. Uses memory space.
  37. .. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
  38. ``default_http_headers`` :
  39. Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__