mirror of
				https://github.com/searxng/searxng.git
				synced 2025-10-31 02:27:06 -04:00 
			
		
		
		
	[readme] reworked / partial merge of #2200
Related: - https://github.com/searxng/searxng/pull/2203 - https://github.com/searxng/searxng/pull/2200#issuecomment-1434594489 Closes: https://github.com/searxng/searxng/pull/2200
This commit is contained in:
		
							parent
							
								
									363203c579
								
							
						
					
					
						commit
						145cac877e
					
				
							
								
								
									
										77
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										77
									
								
								README.rst
									
									
									
									
									
								
							| @ -12,9 +12,9 @@ | |||||||
| 
 | 
 | ||||||
| Privacy-respecting, hackable `metasearch engine`_ | Privacy-respecting, hackable `metasearch engine`_ | ||||||
| 
 | 
 | ||||||
| If you are looking for running instances, ready to use, then visit searx.space_. | Searx.space_ lists ready-to-use running instances. | ||||||
| Otherwise jump to the user_, admin_ and developer_ handbooks you will find on | 
 | ||||||
| our homepage_. | A user_, admin_ and developer_ handbook is available on the homepage_. | ||||||
| 
 | 
 | ||||||
| |SearXNG install| | |SearXNG install| | ||||||
| |SearXNG homepage| | |SearXNG homepage| | ||||||
| @ -66,20 +66,19 @@ our homepage_. | |||||||
| Contact | Contact | ||||||
| ======= | ======= | ||||||
| 
 | 
 | ||||||
| Come join us if you have questions or just want to chat about SearXNG. | Ask questions or just chat about SearXNG on | ||||||
| 
 |  | ||||||
| Matrix |  | ||||||
|   `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_ |  | ||||||
| 
 | 
 | ||||||
| IRC | IRC | ||||||
|   `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_ |   `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_ | ||||||
|   which is bridged to Matrix. |   which is bridged to Matrix. | ||||||
| 
 | 
 | ||||||
|  | Matrix | ||||||
|  |   `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_ | ||||||
| 
 | 
 | ||||||
| Differences to searx | Differences to searx | ||||||
| ==================== | ==================== | ||||||
| 
 | 
 | ||||||
| SearXNG is a fork of `searx`_.  Here are some of the changes: | SearXNG is a fork of `searx`_, with notable changes: | ||||||
| 
 | 
 | ||||||
| .. _searx: https://github.com/searx/searx | .. _searx: https://github.com/searx/searx | ||||||
| 
 | 
 | ||||||
| @ -87,49 +86,48 @@ SearXNG is a fork of `searx`_.  Here are some of the changes: | |||||||
| User experience | User experience | ||||||
| --------------- | --------------- | ||||||
| 
 | 
 | ||||||
| - Huge update of the simple theme: | - Reworked (and still simple) theme: | ||||||
| 
 | 
 | ||||||
|   * usable on desktop, tablet and mobile |   * Usable on desktop, tablet and mobile. | ||||||
|   * light and dark versions (you can choose in the preferences) |   * Light and dark versions (available in the preferences). | ||||||
|   * support right-to-left languages |   * Right-to-left language support. | ||||||
|   * `see the screenshots <https://dev.searxng.org/screenshots.html>`_ |   * `Screenshots <https://dev.searxng.org/screenshots.html>`_ | ||||||
| 
 | 
 | ||||||
| - the translations are up to date, you can contribute on `Weblate`_ | - The translations are up to date, you can contribute on `Weblate`_ | ||||||
| - the preferences page has been updated: | - The preferences page has been updated: | ||||||
| 
 | 
 | ||||||
|   * you can see which engines are reliable or not |   * Browse which engines are reliable or not. | ||||||
|   * engines are grouped inside each tab |   * Engines are grouped inside each tab. | ||||||
|   * each engine has a description |   * Each engine has a description. | ||||||
| 
 | 
 | ||||||
| - thanks to the anonymous metrics, it is easier to report a bug of an engine and | - Thanks to the anonymous metrics, it is easier to report malfunctioning engines, | ||||||
|   thus engines get fixed more quickly |   so they get fixed quicker | ||||||
| 
 | 
 | ||||||
|   - if you don't want any metrics to be recorded, you can `disable them on the server |   - `Turn off metrics on the server | ||||||
|     <https://docs.searxng.org/admin/engines/settings.html#general>`_ |     <https://docs.searxng.org/admin/engines/settings.html#general>`_ if you don't want them recorded. | ||||||
| 
 | 
 | ||||||
| - administrator can `block and/or replace the URLs in the search results | - Administrators can `block and/or replace the URLs in the search results | ||||||
|   <https://github.com/searxng/searxng/blob/5c1c0817c3996c5670a545d05831d234d21e6217/searx/settings.yml#L191-L199>`_ |   <https://github.com/searxng/searxng/blob/5c1c0817c3996c5670a545d05831d234d21e6217/searx/settings.yml#L191-L199>`_ | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| Setup | Setup | ||||||
| ----- | ----- | ||||||
| 
 | 
 | ||||||
| - you don't need `Morty`_ to proxy the images even on a public instance | - No need for `Morty`_ to proxy images, even on a public instance. | ||||||
| - you don't need `Filtron`_ to block bots, we implemented the builtin `limiter`_ | - No need for `Filtron`_ to block bots, as there is now a built-in `limiter`_. | ||||||
| - you get a well maintained `Docker image`_, now also built for ARM64 and ARM/v7 architectures | - A well maintained `Docker image`_, now also built for ARM64 and ARM/v7 architectures. | ||||||
| - alternatively we have up to date installation scripts |   (Alternatively there are up to date installation scripts.) | ||||||
| 
 | 
 | ||||||
| .. _Docker image: https://github.com/searxng/searxng-docker | .. _Docker image: https://github.com/searxng/searxng-docker | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| Contributing is easier | Contributing | ||||||
| ---------------------- | ------------ | ||||||
| 
 | 
 | ||||||
| - readable debug log | - Readable debug log. | ||||||
| - contributions to the themes are made easier, check out our `Development | - Contributing is easier, thanks to the `Development Quickstart`_ guide. | ||||||
|   Quickstart`_ guide | - A lot of code cleanup and bugfixes. | ||||||
| - a lot of code cleanup and bug fixes | - Up to date list dependencies. | ||||||
| - the dependencies are up to date |  | ||||||
| 
 | 
 | ||||||
| .. _Morty: https://github.com/asciimoo/morty | .. _Morty: https://github.com/asciimoo/morty | ||||||
| .. _Filtron: https://github.com/searxng/filtron | .. _Filtron: https://github.com/searxng/filtron | ||||||
| @ -141,15 +139,16 @@ Contributing is easier | |||||||
| Translations | Translations | ||||||
| ============ | ============ | ||||||
| 
 | 
 | ||||||
| We need translators, suggestions are welcome at | Help translate SearXNG at `Weblate`_ | ||||||
| https://translate.codeberg.org/projects/searxng/searxng/ |  | ||||||
| 
 | 
 | ||||||
| .. figure:: https://translate.codeberg.org/widgets/searxng/-/multi-auto.svg | .. figure:: https://translate.codeberg.org/widgets/searxng/-/multi-auto.svg | ||||||
|    :target: https://translate.codeberg.org/projects/searxng/ |    :target: https://translate.codeberg.org/projects/searxng/ | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| Make a donation | Donations | ||||||
| =============== | ========= | ||||||
| 
 | 
 | ||||||
| You can support the SearXNG project by clicking on the donation page: | Support the SearXNG project by clicking the donation page: | ||||||
| https://docs.searxng.org/donate.html | https://docs.searxng.org/donate.html | ||||||
|  | 
 | ||||||
|  | Thank you :) | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user