mirror of
				https://github.com/searxng/searxng.git
				synced 2025-10-31 02:27:06 -04:00 
			
		
		
		
	This patch migrates from `redis==5.2.1` [1] to `valkey==6.1.0` [2].
The migration to valkey is necessary because the company behind Redis has decided
to abandon the open source license. After experiencing a drop in user numbers,
they now want to run it under a dual license again. But this move demonstrates
once again how unreliable the company is and how it treats open source
developers.
To review first, read the docs::
    $ make docs.live
Follow the instructions to remove redis:
- http://0.0.0.0:8000/admin/settings/settings_redis.html
Config and install a local valkey DB:
- http://0.0.0.0:8000/admin/settings/settings_valkey.html
[1] https://pypi.org/project/redis/
[2] https://pypi.org/project/valkey/
Co-authored-by: HLFH <gaspard@dhautefeuille.eu>
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
		
	
			
		
			
				
	
	
		
			66 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			66 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
| .. _settings server:
 | |
| 
 | |
| ===========
 | |
| ``server:``
 | |
| ===========
 | |
| 
 | |
| .. code:: yaml
 | |
| 
 | |
|    server:
 | |
|        base_url: http://example.org/location  # change this!
 | |
|        port: 8888
 | |
|        bind_address: "127.0.0.1"
 | |
|        secret_key: "ultrasecretkey"           # change this!
 | |
|        limiter: false
 | |
|        public_instance: false
 | |
|        image_proxy: false
 | |
|        method: "POST"
 | |
|        default_http_headers:
 | |
|          X-Content-Type-Options : nosniff
 | |
|          X-Download-Options : noopen
 | |
|          X-Robots-Tag : noindex, nofollow
 | |
|          Referrer-Policy : no-referrer
 | |
| 
 | |
| ``base_url`` : ``$SEARXNG_BASE_URL``
 | |
|   The base URL where SearXNG is deployed.  Used to create correct inbound links.
 | |
| 
 | |
| ``port`` & ``bind_address``: ``$SEARXNG_PORT`` & ``$SEARXNG_BIND_ADDRESS``
 | |
|   Port number and *bind address* of the SearXNG web application if you run it
 | |
|   directly using ``python searx/webapp.py``.  Doesn't apply to a SearXNG
 | |
|   services running behind a proxy and using socket communications.
 | |
| 
 | |
| .. _server.secret_key:
 | |
| 
 | |
| ``secret_key`` : ``$SEARXNG_SECRET``
 | |
|   Used for cryptography purpose.
 | |
| 
 | |
| ``limiter`` :  ``$SEARXNG_LIMITER``
 | |
|   Rate limit the number of request on the instance, block some bots.  The
 | |
|   :ref:`limiter` requires a :ref:`settings valkey` database.
 | |
| 
 | |
| .. _public_instance:
 | |
| 
 | |
| ``public_instance`` :  ``$SEARXNG_PUBLIC_INSTANCE``
 | |
| 
 | |
|   Setting that allows to enable features specifically for public instances (not
 | |
|   needed for local usage).  By set to ``true`` the following features are
 | |
|   activated:
 | |
| 
 | |
|   - :py:obj:`searx.botdetection.link_token` in the :ref:`limiter`
 | |
| 
 | |
| .. _image_proxy:
 | |
| 
 | |
| ``image_proxy`` : ``$SEARXNG_IMAGE_PROXY``
 | |
|   Allow your instance of SearXNG of being able to proxy images.  Uses memory space.
 | |
| 
 | |
| .. _method:
 | |
| 
 | |
| ``method`` : ``$SEARXNG_METHOD``
 | |
|   Whether to use ``GET`` or ``POST`` HTTP method when searching.
 | |
| 
 | |
| .. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
 | |
| 
 | |
| ``default_http_headers`` :
 | |
|   Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
 | |
| 
 |