brand:

Back to top

brand:

class searx.brand.SettingsBrand(*, issue_url: str = 'https://github.com/searxng/searxng/issues', docs_url: str = 'https://docs.searxng.org', public_instances: str = 'https://searx.space', wiki_url: str = 'https://github.com/searxng/searxng/wiki', custom: BrandCustom = <factory>, pwa_colors: ThemeColors = <factory>, new_issue_url: str = 'https://github.com/searxng/searxng/issues/new')[source] : Options for configuring brand properties.

```
brand:
  issue_url: https://github.com/searxng/searxng/issues
  docs_url: https://docs.searxng.org
  public_instances: https://searx.space
  wiki_url: https://github.com/searxng/searxng/wiki

  custom:
    links:
      Uptime: https://uptime.searxng.org/history/example-org
      About: https://example.org/user/about.html
```

issue\_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)
:   If you host your own issue tracker change this URL.

docs\_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)
:   If you host your own documentation change this URL.

public\_instances: [str](https://docs.python.org/3/builtins/stdtypes.html#str)
:   If you host your own &lt;https://searx.space> change this URL.

wiki\_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)
:   Link to your wiki (or `false`)

custom: BrandCustom
:   Optional customizing.

    class BrandCustom(*\**, *links: dict[str*, *str]=&lt;factory>*)
    :   Custom settings in the brand section.

        BrandCustom.links: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)[[str](https://docs.python.org/3/builtins/stdtypes.html#str), [str](https://docs.python.org/3/builtins/stdtypes.html#str)]
        :   Custom entries in the footer of the WEB page: `[title]: [link]`

pwa\_colors: ThemeColors
:   Custom settings for PWA colors.

new\_issue\_url: [str](https://docs.python.org/3/builtins/stdtypes.html#str)
:   If you host your own issue tracker not on GitHub, then unset this URL.

    Note: This URL will create a pre-filled GitHub bug report form for an
    engine. Since this feature is implemented only for GH (and limited to
    engines), it will probably be replaced by another solution in the near
    future.

Copyright © SearXNG team

Made with Furo

💾 🌐