Skip to content

docs: Search Providers #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RangerMauve merged 1 commit into from
Feb 27, 2026
Merged

docs: Search Providers #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Here are some docs to get you started with using Agregore.

- [Extensions](./extensions)
- [Theming](./theming)
- [Search Provider](./search-provider)
- [Frequently Asked Questions](../faq)
- [Useful code snippets](./snippets)

Expand Down
43 changes: 43 additions & 0 deletions docs/search-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Configuring the default web search provider

By default, Agregore uses DuckDuckGo's **no-AI** search endpoint for web searches, with a URI template of:

```text
https://noai.duckduckgo.com/?ia=web&q=%s
```

The `%s` in the template is replaced with your search query.

## Available Search Providers

Agregore includes the following privacy-focused search providers in the settings page:

- **DuckDuckGo (No AI)** - `https://noai.duckduckgo.com/?ia=web&q=%s`
- **DuckDuckGo (With AI)** - `https://duckduckgo.com/?ia=web&q=%s`
- **Brave Search** - `https://search.brave.com/search?q=%s`
- **Startpage** - `https://www.startpage.com/do/dsearch?query=%s`
- **SearX (searx.be)** - `https://searx.be/?q=%s`
- **SearXNG (disroot)** - `https://search.disroot.org/?q=%s`
- **Ecosia** - `https://www.ecosia.org/search?q=%s`
- **Mojeek** - `https://www.mojeek.com/search?q=%s`
- **Kagi** - `https://www.kagi.com/search?q=%s`
- **Gibiru** - `https://www.gibiru.com/?q=%s`
- **ArtadoSearch** - `https://www.artadosearch.com/search?Button1=Artado&i=%s`

## Changing the Search Provider

You can change the search provider in two main ways:

- Via the **Settings page** at `agregore://settings`:
- Use the **Search Provider URI Template** field with a **datalist** dropdown containing all the privacy-focused search providers listed above.
- Simply select from the dropdown or type a custom search URL template containing `%s`.
- By editing your `.agregorerc` configuration file directly and setting the `searchProvider` field to your preferred template.

## Adding Custom Search Providers

To add a custom search provider, simply enter the URL template in the Search Provider URI Template field. The template must contain `%s` where the search query should be inserted. For example:

- Google: `https://www.google.com/search?q=%s`
- Bing: `https://www.bing.com/search?q=%s`
- Custom engine: `https://your-search-engine.com/search?query=%s`