first commit

searx/infopage/en/about.md

@@ -0,0 +1,79 @@
+# About SearXNG
+
+SearXNG is a [metasearch engine], aggregating the results of other
+{{link('search engines', 'preferences')}} while not storing information about
+its users.
+
+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]
+
+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 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 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!
+
+## 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] - 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.
+
+When adding a search engine, there must be no duplicates with the same name.  If
+you encounter a problem where you cannot add the search engine, you can either:
+
+- Remove the duplicate (default name: SearXNG) or
+- Contact the owner to give the instance a different name from the default.
+
+## How does it work?
+
+SearXNG is a fork of 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 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!
+
+
+[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://translate.codeberg.org/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

searx/infopage/en/search-syntax.md

@@ -0,0 +1,84 @@
+# Search syntax
+
+SearXNG comes with a search syntax by which you can modify the categories,
+engines, languages, and more.  See the {{link('preferences', 'preferences')}} for
+the list of engines, categories, and languages.
+
+## `!` Select engine and category
+
+To set category and/or engine names, use a `!` prefix.  To give a few examples:
+
+- Search Wikipedia for **paris**:
+
+  - {{search('!wp paris')}}
+  - {{search('!wikipedia paris')}}
+
+- Search in category **map** for **paris**:
+
+  - {{search('!map paris')}}
+
+- Image search
+
+  - {{search('!images Wau Holland')}}
+
+Abbreviations of the engines and languages are also accepted.  Engine/category
+modifiers are chainable and inclusive.  For example, {{search('!map !ddg !wp
+paris')}} searches in the map category and searches DuckDuckGo and Wikipedia for **paris**.
+
+## `:` Select language
+
+To select a language filter use a `:` prefix.  To give an example:
+
+- Search Wikipedia with a custom language:
+
+  - {{search(':fr !wp Wau Holland')}}
+
+## `!!<bang>` External bangs
+
+SearXNG supports the external bangs from [DuckDuckGo].  To directly jump to a
+external search page use the `!!` prefix.  To give an example:
+
+- Search Wikipedia with a custom language:
+
+  - {{search('!!wfr Wau Holland')}}
+
+Please note that your search will be performed directly in the external search
+engine.  SearXNG cannot protect your privacy with this.
+
+[DuckDuckGo]: https://duckduckgo.com/bang
+
+## `!!` automatic redirect
+
+When including `!!` within your search query (separated by spaces), you will
+automatically be redirected to the first result.  This behavior is comparable to
+the "Feeling Lucky" feature from DuckDuckGo.  To give an example:
+
+- Search for a query and get redirected to the first result
+
+  - {{search('!! Wau Holland')}}
+
+Please keep in mind that the result you are being redirected to can't be
+verified for trustworthiness and SearXNG cannot protect your personal privacy
+when using this feature.  Use it at your own risk.
+
+## 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 the _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')}}