Skip to content
Back to top
View this page
Edit this page

# `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')

  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

    If you host your own issue tracker change this URL.

  docs_url: str

    If you host your own documentation change this URL.

  public_instances: str

    If you host your own https://searx.space change this URL.

  wiki_url: str

    Link to your wiki (or `false`)

  custom: BrandCustom

    Optional customizing.

    class BrandCustom(*, links: dict[str, str]=<factory>)

      Custom settings in the brand section.

      BrandCustom.links: dict [ str , str ]

        Custom entries in the footer of the WEB page: `[title]: [link]`

  pwa_colors: ThemeColors

    Custom settings for PWA colors.

  new_issue_url: 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.