diff --git a/AUTHORS.rst b/AUTHORS.rst index 265a9fd41..766b2973e 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -173,4 +173,5 @@ features or generally made searx better: - Austin Olacsi `` - @micsthepick - Daniel Kukula `` -- Patrick Evans `https://github.com/holysoles` \ No newline at end of file +- Patrick Evans `https://github.com/holysoles` +- shreven ``_ B8B56F6FC0EADCA5B6177BC5F599020F48EE6F97 diff --git a/docs/admin/settings/settings_brand.rst b/docs/admin/settings/settings_brand.rst index 0f1a0d9a9..96329d952 100644 --- a/docs/admin/settings/settings_brand.rst +++ b/docs/admin/settings/settings_brand.rst @@ -11,6 +11,10 @@ docs_url: https://docs.searxng.org public_instances: https://searx.space wiki_url: https://github.com/searxng/searxng/wiki + custom_files: + logo: /path/to/file.png + favicon_png: /path/to/file.png + favicon_svg: /path/to/file.svg ``issue_url`` : If you host your own issue tracker change this URL. @@ -23,3 +27,12 @@ ``wiki_url`` : Link to your wiki (or ``false``) + +``custom_files.logo`` : + Filepath to a custom logo. Be sure it has the right file extension, as that's used to determine the mimetype. + +``custom_files.favicon_png`` : + Filepath to a custom PNG favicon. + +``custom_files.favicon_svg`` : + Filepath to a custom SVG favicon. When using, be sure to also set ``custom_files.favicon_png``, as some browsers still don't support SVG favicons. diff --git a/searx/settings.yml b/searx/settings.yml index 4fad73b40..c9f3e3d4b 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -29,6 +29,12 @@ brand: # links: # Uptime: https://uptime.searxng.org/history/darmarit-org # About: "https://searxng.org" + # custom_files: + # # If using custom logo, be sure to set the right file extension as it's used to determine the mimetype. + # logo: /path/to/file.png + # # For custom favicons, you must include a PNG version, as some browsers still don't support SVG favicons. + # favicon_png: /path/to/file.png + # favicon_svg: /path/to/file.svg search: # Filter results. 0: None, 1: Moderate, 2: Strict diff --git a/searx/settings_defaults.py b/searx/settings_defaults.py index b70aaf941..0ed886470 100644 --- a/searx/settings_defaults.py +++ b/searx/settings_defaults.py @@ -152,6 +152,7 @@ SCHEMA = { 'public_instances': SettingsValue((False, str), 'https://searx.space'), 'wiki_url': SettingsValue(str, 'https://github.com/searxng/searxng/wiki'), 'custom': SettingsValue(dict, {'links': {}}), + 'custom_files': SettingsValue(dict, {}), }, 'search': { 'safe_search': SettingsValue((0, 1, 2), 0), diff --git a/searx/static/themes/simple/gruntfile.js b/searx/static/themes/simple/gruntfile.js index c2cbad315..d2b9ab324 100644 --- a/searx/static/themes/simple/gruntfile.js +++ b/searx/static/themes/simple/gruntfile.js @@ -151,7 +151,6 @@ module.exports = function (grunt) { svgo: ['--config', 'svg4web.svgo.js'] }, files: { - '<%= _templates %>/simple/searxng-wordmark.min.svg': '<%= _brand %>/searxng-wordmark.svg', 'img/searxng.svg': '<%= _brand %>/searxng.svg', 'img/img_load_error.svg': '<%= _brand %>/img_load_error.svg' } diff --git a/searx/static/themes/simple/src/less/index.less b/searx/static/themes/simple/src/less/index.less index 8590d0c3b..758d11eb9 100644 --- a/searx/static/themes/simple/src/less/index.less +++ b/searx/static/themes/simple/src/less/index.less @@ -6,7 +6,11 @@ text-align: center; .title { - background: url('../img/searxng.png') no-repeat; + &.custom_logo { + background-image: url('../../../../custom/logo'); + } + background-image: url('../img/searxng.png'); + background-repeat: no-repeat; min-height: 4rem; margin: 4rem auto; background-position: center; diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html index 93a1a3902..42c17946f 100644 --- a/searx/templates/simple/base.html +++ b/searx/templates/simple/base.html @@ -27,9 +27,11 @@ {% block head %} {% endblock %} - - - + + + {% if not get_setting('brand.custom_files.favicon_png', false) or get_setting('brand.custom_files.favicon_svg', false) %} + + {% endif %}
diff --git a/searx/templates/simple/index.html b/searx/templates/simple/index.html index 5c207bbd9..d34609c0b 100644 --- a/searx/templates/simple/index.html +++ b/searx/templates/simple/index.html @@ -2,7 +2,7 @@ {% from 'simple/icons.html' import icon_big %} {% block content %}
-

SearXNG

+

SearXNG

{% include 'simple/simple_search.html' %}
{% endblock %} diff --git a/searx/templates/simple/opensearch.xml b/searx/templates/simple/opensearch.xml index 5176c012c..e1ba83ede 100644 --- a/searx/templates/simple/opensearch.xml +++ b/searx/templates/simple/opensearch.xml @@ -4,7 +4,7 @@ SearXNG metasearch SearXNG is a metasearch engine that respects your privacy. UTF-8 - {{ url_for('static', filename='img/favicon.png', _external=True) }} + {{ url_for('custom', custom_file='favicon_png', filename='img/favicon.png', _external=True) }} {% if opensearch_method == 'GET' %} {% else %} diff --git a/searx/templates/simple/page_with_header.html b/searx/templates/simple/page_with_header.html index 719553a38..5e91878a8 100644 --- a/searx/templates/simple/page_with_header.html +++ b/searx/templates/simple/page_with_header.html @@ -2,6 +2,6 @@ {%- extends "simple/base.html" -%} {%- block header -%} {{- '' -}} - {{- '' -}} + {{- '' -}} {{- '' -}} {%- endblock -%} diff --git a/searx/templates/simple/search.html b/searx/templates/simple/search.html index 360873c76..023038294 100644 --- a/searx/templates/simple/search.html +++ b/searx/templates/simple/search.html @@ -2,7 +2,12 @@
diff --git a/searx/templates/simple/searxng-wordmark.min.svg b/searx/templates/simple/searxng-wordmark.min.svg deleted file mode 100644 index 13fb238e1..000000000 --- a/searx/templates/simple/searxng-wordmark.min.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/searx/webapp.py b/searx/webapp.py index bbc71fdd6..c8bef62e6 100755 --- a/searx/webapp.py +++ b/searx/webapp.py @@ -37,6 +37,7 @@ from flask import ( make_response, redirect, send_from_directory, + send_file, ) from flask.wrappers import Response from flask.json import jsonify @@ -74,6 +75,7 @@ from searx import webutils from searx.webutils import ( highlight_content, get_static_files, + get_custom_files, get_result_templates, get_themes, exception_classname_to_text, @@ -132,6 +134,7 @@ if not searx_debug and settings['server']['secret_key'] == 'ultrasecretkey': # about static logger.debug('static directory is %s', settings['ui']['static_path']) static_files = get_static_files(settings['ui']['static_path']) +custom_files = get_custom_files() # about templates logger.debug('templates directory is %s', settings['ui']['templates_path']) @@ -256,6 +259,15 @@ def get_result_template(theme_name: str, template_name: str): def custom_url_for(endpoint: str, **values): suffix = "" + if endpoint == 'custom' and values.get('custom_file'): + if values['custom_file'] in custom_files: + values.pop('filename') + if get_setting('ui.static_use_hash'): + suffix = "?" + custom_files[values['custom_file']]['hash'] + else: + # if there's no custom file defined in settings.yml, then use the default file + values.pop('custom_file') + endpoint = 'static' if endpoint == 'static' and values.get('filename'): file_hash = static_files.get(values['filename']) if not file_hash: @@ -1279,8 +1291,25 @@ def opensearch(): return resp +@app.route('/custom/') +def custom(custom_file): + if custom_file in custom_files: + filepath = custom_files[custom_file]['path'] + if os.path.isfile(filepath): + if 'mimetype' in custom_files[custom_file]: + return send_file(filepath, mimetype=custom_files[custom_file]['mimetype']) + return send_file(filepath) + logger.warning('%s does not exist or is not a file', filepath) + return flask.abort(404) + + @app.route('/favicon.ico') def favicon(): + if 'favicon_png' in custom_files: + filepath = custom_files['favicon_png']['path'] + if os.path.isfile(filepath): + return send_file(filepath, mimetype='image/png') + logger.warning('%s does not exist or is not a file', filepath) theme = request.preferences.get_value("theme") return send_from_directory( os.path.join(app.root_path, settings['ui']['static_path'], 'themes', theme, 'img'), # pyright: ignore diff --git a/searx/webutils.py b/searx/webutils.py index c58b981f6..328402a5e 100644 --- a/searx/webutils.py +++ b/searx/webutils.py @@ -204,6 +204,28 @@ def get_static_files(static_path: str) -> Dict[str, str]: return static_files +def get_custom_files() -> Dict[str, dict]: + custom_files: Dict[str, dict] = {} + + for option in settings['brand']['custom_files']: + filepath = settings['brand']['custom_files'][option] + if os.path.isfile(filepath): + custom_files.setdefault(option, {}) + custom_files[option]['path'] = filepath + custom_files[option]['hash'] = get_hash_for_file(pathlib.Path(filepath)) + if option == 'favicon_png': + custom_files[option]['mimetype'] = 'image/png' + if option == 'favicon_svg': + custom_files[option]['mimetype'] = 'image/svg+xml' + else: + logger.warning('%s does not exist or is not a file', filepath) + + if 'favicon_svg' in custom_files and 'favicon_png' not in custom_files: + logger.warning('Some browsers only support PNG favicons, but you have only set an SVG favicon') + + return custom_files + + def get_result_templates(templates_path): result_templates = set() templates_path_length = len(templates_path) + 1 diff --git a/utils/lib_sxng_static.sh b/utils/lib_sxng_static.sh index 2f074b91e..31a952e77 100755 --- a/utils/lib_sxng_static.sh +++ b/utils/lib_sxng_static.sh @@ -8,7 +8,6 @@ STATIC_BUILT_PATHS=( 'searx/static/themes/simple/js' 'searx/static/themes/simple/src/generated/pygments.less' 'searx/static/themes/simple/img' - 'searx/templates/simple/searxng-wordmark.min.svg' 'searx/templates/simple/icons.html' )