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

# Discourse Forums

Discourse is an open source Internet forum system. To search in a forum this engine offers some additional settings:

- `base_url`

- `api_order`

- `search_endpoint`

- `show_avatar`

- `api_key`

- `api_username`

## Example

To search in your favorite Discourse forum, add a configuration like shown here for the `paddling.com` forum:

    - name: paddling
      engine: discourse
      shortcut: paddle
      base_url: 'https://forums.paddling.com/'
      api_order: views
      categories: ['social media', 'sports']
      show_avatar: true

If the forum is private, you need to add an API key and username for the search:

    - name: paddling
      engine: discourse
      shortcut: paddle
      base_url: 'https://forums.paddling.com/'
      api_order: views
      categories: ['social media', 'sports']
      show_avatar: true
      api_key: '<KEY>'
      api_username: 'system'

## Implementations

searx.engines.discourse.base_url: str = None

  URL of the Discourse forum.

searx.engines.discourse.search_endpoint = '/search.json'

  URL path of the search endpoint.

searx.engines.discourse.api_order = 'likes'

  Order method, valid values are: `latest`, `likes`, `views`, `latest_topic`

searx.engines.discourse.show_avatar = False

  Show avatar of the user who send the post.

searx.engines.discourse.api_key = ''

  API key of the Discourse forum.

searx.engines.discourse.api_username = ''

  API username of the Discourse forum.