mirror of
				https://github.com/searxng/searxng.git
				synced 2025-11-03 19:17:07 -05:00 
			
		
		
		
	
						commit
						27f8fa6fe0
					
				@ -1,75 +1,75 @@
 | 
			
		||||
# About SearXNG
 | 
			
		||||
 | 
			
		||||
SearXNG is a fork from the well-known [searx] [metasearch engine], aggregating
 | 
			
		||||
the results of other {{link('search engines', 'preferences')}} while not
 | 
			
		||||
storing information about its users.
 | 
			
		||||
SearXNG is a [metasearch engine], aggregating the results of other
 | 
			
		||||
{{link('search engines', 'preferences')}} while not storing information about
 | 
			
		||||
its users.
 | 
			
		||||
 | 
			
		||||
More about SearXNG ...
 | 
			
		||||
The SearXNG project is driven by an open community, come join us on
 | 
			
		||||
Matrix if you have questions or just want to chat about SearXNG at [#searxng:matrix.org]
 | 
			
		||||
 | 
			
		||||
* [SearXNG sources]({{GIT_URL}})
 | 
			
		||||
* [weblate]
 | 
			
		||||
Make SearXNG better.
 | 
			
		||||
 | 
			
		||||
- You can improve SearXNG translations at [Weblate], or...
 | 
			
		||||
- Track development, send contributions, and report issues at [SearXNG sources].
 | 
			
		||||
- To get further information, visit SearXNG's project documentation at [SearXNG
 | 
			
		||||
  docs].
 | 
			
		||||
 | 
			
		||||
## Why use it?
 | 
			
		||||
 | 
			
		||||
* SearXNG may not offer you as personalised results as Google, but it doesn't
 | 
			
		||||
- SearXNG may not offer you as personalized results as Google, but it doesn't
 | 
			
		||||
  generate a profile about you.
 | 
			
		||||
 | 
			
		||||
* SearXNG doesn't care about what you search for, never shares anything with a
 | 
			
		||||
  third party, and it can't be used to compromise you.
 | 
			
		||||
 | 
			
		||||
* SearXNG is free software, the code is 100% open and you can help to make it
 | 
			
		||||
  better.  See more on [SearXNG sources]({{GIT_URL}}).
 | 
			
		||||
- SearXNG doesn't care about what you search for, never shares anything with a
 | 
			
		||||
  third-party, and it can't be used to compromise you.
 | 
			
		||||
- SearXNG is free software, the code is 100% open, and everyone is welcome to
 | 
			
		||||
  make it better.
 | 
			
		||||
 | 
			
		||||
If you do care about privacy, want to be a conscious user, or otherwise believe
 | 
			
		||||
in digital freedom, make SearXNG your default search engine or run it on your
 | 
			
		||||
own server
 | 
			
		||||
own server!
 | 
			
		||||
 | 
			
		||||
## Technical details - How does it work?
 | 
			
		||||
 | 
			
		||||
SearXNG is a [metasearch engine], inspired by the [seeks project].  It provides
 | 
			
		||||
basic privacy by mixing your queries with searches on other platforms without
 | 
			
		||||
storing search data. Queries are made using a POST request on every browser
 | 
			
		||||
(except Chromium-based browsers*).  Therefore they show up in neither our logs,
 | 
			
		||||
nor your url history. In the case of Chromium-based browser users there is an
 | 
			
		||||
exception: searx uses the search bar to perform GET requests.  SearXNG can be
 | 
			
		||||
added to your browser's search bar; moreover, it can be set as the default
 | 
			
		||||
search engine.
 | 
			
		||||
 | 
			
		||||
## How to set as the default search engine?
 | 
			
		||||
## How do I set it as the default search engine?
 | 
			
		||||
 | 
			
		||||
SearXNG supports [OpenSearch].  For more information on changing your default
 | 
			
		||||
search engine, see your browser's documentation:
 | 
			
		||||
 | 
			
		||||
* [Firefox]
 | 
			
		||||
* [Microsoft Edge]
 | 
			
		||||
* Chromium-based browsers [only add websites that the user navigates to without
 | 
			
		||||
  a path.](https://www.chromium.org/tab-to-search)
 | 
			
		||||
- [Firefox]
 | 
			
		||||
- [Microsoft Edge] - Behind the link, you will also find some useful instructions
 | 
			
		||||
  for Chrome and Safari.
 | 
			
		||||
- [Chromium]-based browsers only add websites that the user navigates to without
 | 
			
		||||
  a path.
 | 
			
		||||
 | 
			
		||||
## Where to find anonymous usage statistics of this instance ?
 | 
			
		||||
 | 
			
		||||
{{link('Stats page', 'stats')}} contains some useful data about the engines
 | 
			
		||||
used.
 | 
			
		||||
## How does it work?
 | 
			
		||||
 | 
			
		||||
SearXNG is a fork from the well-known [searx] [metasearch engine] which was
 | 
			
		||||
inspired by the [Seeks project].  It provides basic privacy by mixing your
 | 
			
		||||
queries with searches on other platforms without storing search data.  SearXNG
 | 
			
		||||
can be added to your browser's search bar; moreover, it can be set as the
 | 
			
		||||
default search engine.
 | 
			
		||||
 | 
			
		||||
The {{link('stats page', 'stats')}} contains some useful anonymous usage
 | 
			
		||||
statistics about the engines used.
 | 
			
		||||
 | 
			
		||||
## How can I make it my own?
 | 
			
		||||
 | 
			
		||||
SearXNG appreciates your concern regarding logs, so take the code from the
 | 
			
		||||
[SearXNG project]({{GIT_URL}}) and run it yourself!
 | 
			
		||||
[SearXNG sources] and run it yourself!
 | 
			
		||||
 | 
			
		||||
Add your instance to this [list of public
 | 
			
		||||
instances]({{get_setting('brand.public_instances')}}) to help other people
 | 
			
		||||
reclaim their privacy and make the Internet freer!  The more decentralized the
 | 
			
		||||
Internet is, the more freedom we have!
 | 
			
		||||
reclaim their privacy and make the internet freer.  The more decentralized the
 | 
			
		||||
internet is, the more freedom we have!
 | 
			
		||||
 | 
			
		||||
## Where are the docs & code of this instance?
 | 
			
		||||
 | 
			
		||||
See the [SearXNG docs]({{get_setting('brand.docs_url')}}) and [SearXNG
 | 
			
		||||
sources]({{GIT_URL}})
 | 
			
		||||
 | 
			
		||||
[SearXNG sources]: {{GIT_URL}}
 | 
			
		||||
[#searxng:matrix.org]: https://matrix.to/#/#searxng:matrix.org
 | 
			
		||||
[SearXNG docs]: {{get_setting('brand.docs_url')}}
 | 
			
		||||
[searx]: https://github.com/searx/searx
 | 
			
		||||
[metasearch engine]: https://en.wikipedia.org/wiki/Metasearch_engine
 | 
			
		||||
[weblate]: https://weblate.bubu1.eu/projects/searxng/
 | 
			
		||||
[seeks project]: https://beniz.github.io/seeks/
 | 
			
		||||
[Weblate]: https://weblate.bubu1.eu/projects/searxng/
 | 
			
		||||
[Seeks project]: https://beniz.github.io/seeks/
 | 
			
		||||
[OpenSearch]: https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md
 | 
			
		||||
[Firefox]: https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox
 | 
			
		||||
[Microsoft Edge]: https://support.microsoft.com/en-us/help/4028574/microsoft-edge-change-the-default-search-engine
 | 
			
		||||
[Chromium]: https://www.chromium.org/tab-to-search
 | 
			
		||||
 | 
			
		||||
@ -1,35 +1,70 @@
 | 
			
		||||
# Search syntax
 | 
			
		||||
 | 
			
		||||
SearXNG allows you to modify the default categories, engines and search language
 | 
			
		||||
via the search query.
 | 
			
		||||
SearXNG comes with a search syntax by with you can modify the categories,
 | 
			
		||||
engines, languages and more.  See the {{link('preferences', 'preferences')}} for
 | 
			
		||||
the list of engines, categories and languages.
 | 
			
		||||
 | 
			
		||||
Prefix `!` to set category and engine names.
 | 
			
		||||
## `!` select engine and category
 | 
			
		||||
 | 
			
		||||
Prefix: `:` to set the language.
 | 
			
		||||
To set category and/or engine names use a `!` prefix.  To give a few examples:
 | 
			
		||||
 | 
			
		||||
Abbrevations of the engines and languages are also accepted.  Engine/category
 | 
			
		||||
modifiers are chainable and inclusive.  E.g. with {{search('!map !ddg !wp paris')}}
 | 
			
		||||
search in map category **and** duckduckgo **and** wikipedia for
 | 
			
		||||
`paris`.
 | 
			
		||||
- search in wikipedia for **paris**
 | 
			
		||||
 | 
			
		||||
See the {{link('preferences', 'preferences')}} for the list of engines,
 | 
			
		||||
categories and languages.
 | 
			
		||||
  - {{search('!wp paris')}}
 | 
			
		||||
  - {{search('!wikipedia paris')}}
 | 
			
		||||
 | 
			
		||||
## Examples
 | 
			
		||||
- search in category **map** for **paris**
 | 
			
		||||
 | 
			
		||||
Search in wikipedia for `paris`:
 | 
			
		||||
  - {{search('!map paris')}}
 | 
			
		||||
 | 
			
		||||
* {{search('!wp paris')}}
 | 
			
		||||
* {{search('!wikipedia paris')}}
 | 
			
		||||
- image search
 | 
			
		||||
 | 
			
		||||
Search in category `map` for `paris`:
 | 
			
		||||
  - {{search('!images Wau Holland')}}
 | 
			
		||||
 | 
			
		||||
* {{search('!map paris')}}
 | 
			
		||||
Abbreviations of the engines and languages are also accepted.  Engine/category
 | 
			
		||||
modifiers are chain able and inclusive.  E.g. with {{search('!map !ddg !wp
 | 
			
		||||
paris')}} search in map category and duckduckgo and wikipedia for **paris**.
 | 
			
		||||
 | 
			
		||||
Image search:
 | 
			
		||||
## `:` select language
 | 
			
		||||
 | 
			
		||||
* {{search('!images Wau Holland')}}
 | 
			
		||||
To select language filter use a `:` prefix.  To give an example:
 | 
			
		||||
 | 
			
		||||
Custom language in wikipedia:
 | 
			
		||||
- search wikipedia by a custom language
 | 
			
		||||
 | 
			
		||||
* {{search(':fr !wp Wau Holland')}}
 | 
			
		||||
  - {{search(':fr !wp Wau Holland')}}
 | 
			
		||||
 | 
			
		||||
## `!!` external bangs
 | 
			
		||||
 | 
			
		||||
SearXNG supports the external bangs from [ddg].  To directly jump to a external
 | 
			
		||||
search page use the `!!` prefix.  To give an example:
 | 
			
		||||
 | 
			
		||||
- search wikipedia by a custom language
 | 
			
		||||
 | 
			
		||||
  - {{search('!!wfr Wau Holland')}}
 | 
			
		||||
 | 
			
		||||
Please note, your search will be performed directly in the external search
 | 
			
		||||
engine, SearXNG cannot protect your privacy on this.
 | 
			
		||||
 | 
			
		||||
[ddg]: https://duckduckgo.com/bang
 | 
			
		||||
 | 
			
		||||
## Special Queries
 | 
			
		||||
 | 
			
		||||
In the {{link('preferences', 'preferences')}} page you find keywords for
 | 
			
		||||
_special queries_.  To give a few examples:
 | 
			
		||||
 | 
			
		||||
- generate a random UUID
 | 
			
		||||
 | 
			
		||||
  - {{search('random uuid')}}
 | 
			
		||||
 | 
			
		||||
- find the average
 | 
			
		||||
 | 
			
		||||
  - {{search('avg 123 548 2.04 24.2')}}
 | 
			
		||||
 | 
			
		||||
- show _user agent_ of your browser (needs to be activated)
 | 
			
		||||
 | 
			
		||||
  - {{search('user-agent')}}
 | 
			
		||||
 | 
			
		||||
- convert strings to different hash digests (needs to be activated)
 | 
			
		||||
 | 
			
		||||
  - {{search('md5 lorem ipsum')}}
 | 
			
		||||
  - {{search('sha512 lorem ipsum')}}
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user