Initialize Redis in searx/webapp.py

settings.yml:
* The default URL was unix:///usr/local/searxng-redis/run/redis.sock?db=0
* The default URL is now "false"

The default URL makes the log difficult to deal with:
if the admin didn't install a Redis instance, the logs record a false error.

It worked before because SearXNG initialized the Redis connection when the limiter started.

In this commit, SearXNG initializes Redis in searx/webapp.py
so various components can use Redis without taking care of the initialization step.
This commit is contained in:
Alexandre FLAMENT 2022-10-14 13:27:07 +00:00 committed by Alexandre Flament
parent fe419e355b
commit e92755d358
7 changed files with 36 additions and 24 deletions

View file

@ -314,20 +314,21 @@ developer) account needs to be added to the *searxng-redis* group.
.. admonition:: Tip for developers .. admonition:: Tip for developers
To set up a local redis instance using sockets simply use:: To set up a local redis instance, first set the socket path of the Redis DB
in your YAML setting:
$ ./manage redis.build
$ sudo -H ./manage redis.install
$ sudo -H ./manage redis.addgrp "${USER}"
# don't forget to logout & login to get member of group
The YAML setting for such a redis instance is:
.. code:: yaml .. code:: yaml
redis: redis:
url: unix:///usr/local/searxng-redis/run/redis.sock?db=0 url: unix:///usr/local/searxng-redis/run/redis.sock?db=0
Then use the following commands to install the redis instance ::
$ ./manage redis.build
$ sudo -H ./manage redis.install
$ sudo -H ./manage redis.addgrp "${USER}"
# don't forget to logout & login to get member of group
.. _settings outgoing: .. _settings outgoing:

View file

@ -18,8 +18,8 @@ if (next_call_ts == false or next_call_ts == nil) then
-- the scheduler has never run on this Redis instance, so: -- the scheduler has never run on this Redis instance, so:
-- 1/ the scheduler does not run now -- 1/ the scheduler does not run now
-- 2/ the next call is a random time between start_after_from and start_after_to -- 2/ the next call is a random time between start_after_from and start_after_to
local delay = start_after_from + math.random(start_after_to - start_after_from) local initial_delay = math.random(start_after_from, start_after_to)
redis.call('SET', redis_key, now + delay) redis.call('SET', redis_key, now + initial_delay)
return { false, delay } return { false, delay }
end end
@ -30,7 +30,7 @@ local call_now = next_call_ts <= now
if call_now then if call_now then
-- the checker runs now, define the timestamp of the next call: -- the checker runs now, define the timestamp of the next call:
-- this is a random delay between every_from and every_to -- this is a random delay between every_from and every_to
local periodic_delay = every_from + math.random(every_to - every_from) local periodic_delay = math.random(every_from, every_to)
next_call_ts = redis.call('INCRBY', redis_key, periodic_delay) next_call_ts = redis.call('INCRBY', redis_key, periodic_delay)
end end
return { call_now, next_call_ts - now } return { call_now, next_call_ts - now }

View file

@ -78,7 +78,7 @@ server:
redis: redis:
# https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url # https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url
url: unix:///usr/local/searxng-redis/run/redis.sock?db=0 url: false
ui: ui:
# Custom static path - leave it blank if you didn't change # Custom static path - leave it blank if you didn't change

View file

@ -174,7 +174,7 @@ SCHEMA = {
'default_http_headers': SettingsValue(dict, {}), 'default_http_headers': SettingsValue(dict, {}),
}, },
'redis': { 'redis': {
'url': SettingsValue(str, 'unix:///usr/local/searxng-redis/run/redis.sock?db=0'), 'url': SettingsValue((None, False, str), False),
}, },
'ui': { 'ui': {
'static_path': SettingsDirectoryValue(str, os.path.join(searx_dir, 'static')), 'static_path': SettingsDirectoryValue(str, os.path.join(searx_dir, 'static')),

View file

@ -26,20 +26,31 @@ import redis
from searx import get_setting from searx import get_setting
OLD_REDIS_URL_DEFAULT_URL = 'unix:///usr/local/searxng-redis/run/redis.sock?db=0'
"""This was the default Redis URL in settings.yml."""
_CLIENT = None
logger = logging.getLogger('searx.shared.redisdb') logger = logging.getLogger('searx.shared.redisdb')
_client = None
def client() -> redis.Redis: def client() -> redis.Redis:
return _client return _CLIENT
def initialize(): def initialize():
global _client # pylint: disable=global-statement global _CLIENT # pylint: disable=global-statement
redis_url = get_setting('redis.url')
try: try:
_client = redis.Redis.from_url(get_setting('redis.url')) if redis_url:
logger.info("connected redis: %s", get_setting('redis.url')) _CLIENT = redis.Redis.from_url(redis_url)
except redis.exceptions.ConnectionError as exc: logger.info("connected redis: %s", redis_url)
return True
except redis.exceptions.ConnectionError:
_pw = pwd.getpwuid(os.getuid()) _pw = pwd.getpwuid(os.getuid())
logger.error("[%s (%s)] can't connect redis DB ...", _pw.pw_name, _pw.pw_uid) logger.exception("[%s (%s)] can't connect redis DB ...", _pw.pw_name, _pw.pw_uid)
logger.error(" %s", exc) if redis_url == OLD_REDIS_URL_DEFAULT_URL:
logger.info(
"You can safely ignore the above Redis error if you don't use Redis."
"You can remove this error by setting redis.url to false in your settings.yml."
)
return False

View file

@ -295,7 +295,7 @@ In your instance, redis DB connector is configured at:
${redis_url} ${redis_url}
" "
if searxng.instance.exec python -c "from searx.shared import redisdb; redisdb.init() or exit(42)"; then if searxng.instance.exec python -c "from searx.shared import redisdb; redisdb.initialize() or exit(42)"; then
info_msg "SearXNG instance is able to connect redis DB." info_msg "SearXNG instance is able to connect redis DB."
return return
fi fi
@ -684,7 +684,7 @@ To install uWSGI use::
die 42 "SearXNG's uWSGI app not available" die 42 "SearXNG's uWSGI app not available"
fi fi
if ! searxng.instance.exec python -c "from searx.shared import redisdb; redisdb.init() or exit(42)"; then if ! searxng.instance.exec python -c "from searx.shared import redisdb; redisdb.initialize() or exit(42)"; then
rst_para "\ rst_para "\
The configured redis DB is not available: If your server is public to the The configured redis DB is not available: If your server is public to the
internet, you should setup a bot protection to block excessively bot queries. internet, you should setup a bot protection to block excessively bot queries.

View file

@ -29,6 +29,6 @@ if os.path.isfile(OLD_SETTING):
from searx.shared import redisdb from searx.shared import redisdb
from searx import get_setting from searx import get_setting
if not redisdb.init(): if not redisdb.initialize():
warnings.warn("can't connect to redis DB at: %s" % get_setting('redis.url'), RuntimeWarning, stacklevel=2) warnings.warn("can't connect to redis DB at: %s" % get_setting('redis.url'), RuntimeWarning, stacklevel=2)
warnings.warn("--> no bot protection without redis DB", RuntimeWarning, stacklevel=2) warnings.warn("--> no bot protection without redis DB", RuntimeWarning, stacklevel=2)