Source-Code

This is a partial documentation of our source code. We are not aiming to document every item from the source code, but we will add documentation when requested.

• Custom message extractor (i18n)
  • extract()
• Bot Detection
  • get_network()
  • get_real_ip()
  • too_many_requests()
  • IP lists
  • Rate limit
  • Probe HTTP headers
  • Config
• SearXNG Exceptions
  • SearxException
  • SearxParameterException
  • SearxSettingsException
  • SearxEngineException
  • SearxXPathSyntaxException
  • SearxEngineResponseException
  • SearxEngineAPIException
  • SearxEngineAccessDeniedException
  • SearxEngineCaptchaException
  • SearxEngineTooManyRequestsException
  • SearxEngineXPathException
• Favicons (source)
  • favicon_url()
  • favicon_proxy()
  • Favicons Config
  • Favicons Proxy
  • Favicons Resolver
  • Favicons Cache
• Online /info
  • InfoPage
  • InfoPageSet
• Locales
  • SearXNG’s locale data
  • SearXNG’s locale codes
  • SearXNG’s locale implementations
  • LOCALE_NAMES
  • RTL_LOCALES
  • ADDITIONAL_TRANSLATIONS
  • LOCALE_BEST_MATCH
  • get_translations()
  • get_translation_locales()
  • locales_initialize()
  • region_tag()
  • language_tag()
  • get_locale()
  • get_official_locales()
  • get_engine_locale()
  • match_locale()
  • build_engine_locales()
• Redis DB
  • OLD_REDIS_URL_DEFAULT_URL
• Redis Library
  • LUA_SCRIPT_STORAGE
  • lua_script_storage()
  • purge_by_prefix()
  • secret_hash()
  • incr_counter()
  • drop_counter()
  • incr_sliding_window()
• Search
  • EngineRef
  • SearchQuery
  • Search
  • SearchWithPlugins
• Search processors
  • Abstract processor class
  • Offline processor
  • Online processor
  • Online currency processor
  • Online dictionary processor
  • Online URL search processor
• Settings Loader
  • DEFAULT_SETTINGS_FILE
  • load_yaml()
  • get_yaml_cfg()
  • get_user_cfg_folder()
  • load_settings()
• SQLite DB
  • SQLiteAppl
  • SQLiteProperties
• Utility functions for the engines
  • SEARCH_LANGUAGE_CODES
  • searx_useragent()
  • gen_useragent()
  • html_to_text()
  • markdown_to_text()
  • extract_text()
  • normalize_url()
  • extract_url()
  • dict_subset()
  • humanize_bytes()
  • humanize_number()
  • convert_str_to_int()
  • extr()
  • int_or_zero()
  • is_valid_lang()
  • to_string()
  • ecma_unescape()
  • get_engine_from_settings()
  • get_xpath()
  • eval_xpath()
  • eval_xpath_list()
  • eval_xpath_getindex()
  • get_embeded_stream_url()
  • detect_language()
  • js_variable_to_python()