Browse Source

Add SearXNG Doc page

Rafael Blumberg 3 years ago
parent
commit
a19886c4fd

+ 9 - 0
build/appinfo.json

@@ -62,6 +62,10 @@
 			"Title": "Samba",
 			"VideoID": 10
 		},
+		{
+			"Title": "SearXNG",
+			"DocID": 10
+		},
 		{
 			"Title": "Traefik",
 			"ScriptID": 10
@@ -216,6 +220,11 @@
 			"ID": 9,
 			"File": "photoprism.md",
 			"Description": "Install and Setup Instructions for PhotoPrism Stack"
+		},
+		{
+			"ID": 10,
+			"File": "searxng.md",
+			"Description": "Install and Setup Instructions for SearXNG Meta Search"
 		}
 	],
 

+ 2 - 1
docs/AppList.md

@@ -109,13 +109,14 @@ List of all apps included in this project with info related to it.
 |Quassel IRC|32/64 bit|Container|  |  |  |  |
 |Radarr|32/64 bit|Container|  |  |  |  |
 |Raspberry Pi Docker Monitor|32/64 bit|Stack| [![](../build/images/doc_icon.png)](../docs/rpi_docker_monitor.md) | [![](../build/images/script_icon.png)](../tools/rpi_docker_monitor.sh) |  | [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)](https://www.youtube.com/watch?v=IoD3vFuep64&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=8) |
+|RDesktop|32/64 bit|Container|  |  |  |  |
 |Reactive-Resume|64 bit|Container|  |  |  |  |
 |Redmine|32/64 bit|Stack|  |  |  |  |
 |Resilio Sync|32/64 bit|Container|  |  |  |  |
 |ruTorrent|32/64 bit|Container|  |  |  |  |
 |SABnzbd|32/64 bit|Container|  |  |  |  |
 |Samba|32/64 bit|Container|  |  |  | [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)](https://www.youtube.com/watch?v=2zZ3_1GRWrM&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=11) |
-|SearXNG|32/64 bit|Container|  |  |  |  |
+|SearXNG|32/64 bit|Container| [![](../build/images/doc_icon.png)](../docs/searxng.md) |  |  |  |
 |Shiori|32/64 bit|Container|  |  |  |  |
 |SickChill|32/64 bit|Container|  |  |  |  |
 |SickGear|32/64 bit|Container|  |  |  |  |

+ 1 - 0
docs/DocumentList.md

@@ -13,6 +13,7 @@ List of all Documents used within this project with related Apps and Videos.
 |[photoprism.md](../docs/photoprism.md)|Install and Setup Instructions for PhotoPrism Stack|PhotoPrism||
 |[pi-hole.md](../docs/pi-hole.md)|Install and Setup Pi-Hole for Network-Wide Ad Block|Pi-Hole<br>Pi-Hole DoH/DoT<br>Pi-Hole-Unbound||
 |[rpi_docker_monitor.md](../docs/rpi_docker_monitor.md)|Install and setup instructions for the RPI Docker Monitor|Raspberry Pi Docker Monitor|[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)]("https://www.youtube.com/watch?v=IoD3vFuep64&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=8")|
+|[searxng.md](../docs/searxng.md)|Install and Setup Instructions for SearXNG Meta Search|SearXNG||
 |[throttled.md](../docs/throttled.md)|Install and Setup Instructions for the Throttled Script|||
 |[wireguard-install.md](../docs/wireguard-install.md)|Install and setup instructions for the WireGuard VPN Server|Wireguard Server||
 |[wordpress_installation.md](../docs/wordpress_installation.md)|WORDPRESS + SSL SETUP|Wordpress||

BIN
docs/images/searxng_DeployContainer.png


BIN
docs/images/searxng_searchExample.png


BIN
docs/images/searxng_templateApp.png


+ 59 - 0
docs/searxng.md

@@ -0,0 +1,59 @@
+# Install and Setup instructions for SearxNG
+
+## Introduction
+
+[SearXNG](https://docs.searxng.org/) is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled.
+
+![SearXNG Page](images/searxng_searchExample.png)
+
+## Installation
+
+![SearXNG on Template list](images/searxng_templateApp.png)
+
+Look for `SearXNG` on Template list.
+
+![SearXNG deploy configuration](images/searxng_DeployContainer.png)
+
+For the configuration, correct `BASE_URL` variable with a domain (if using one) or replace `localhost` with the Raspberry Pi's IP.
+
+You can change `INSTANCE_NAME` to anything you want and it's not required.
+
+Once done, click in `Deploy the container`.
+
+## Configuring
+
+Once deployed, you can view and modify all configurations under `/portainer/Files/AppData/Config/searxng/settings.yml`. Visit the [official doc page](https://docs.searxng.org/admin/engines/settings.html) for details on each setting.
+
+The main thing you might want to do is to set:
+
+- `general`
+	+ `instance_name`: To give a more personal looking
+- `search`
+	+ `languages`: set here any Language you want to use
+- server:
+	+ `port`: DON'T CHANGE, this is set within the container
+	+ `bind_address`: DON'T CHANGE, this is set within the container
+	+ `base_url`: DON'T CHANGE, this is set within the container
+	+ `secret_key`: A random one is generated when deploying, don't need to change
+- `ui`
+	+ `default_theme`: **oscar** or **simple**
+	+ `theme_args`:
+		* `oscar_style`: **logicodev**, **logicodev-dark** or **pointhi**
+
+From there, you can scroll down to `engines` and **enable/disable** anyone you want.
+
+## Troubleshooting
+
+### Google "Suspended: too many requests"
+
+Try enabling `use_mobile_ui: true` in google section of `/portainer/Files/AppData/Config/searxng/settings.yml` ([Reference](https://github.com/searxng/searxng/issues/531))
+
+```yaml
+ - name: google 
+   engine: google 
+   shortcut: go 
+   # see https://searxng.github.io/searxng/src/searx.engines.google.html#module-searx.engines.google 
+   use_mobile_ui: true 
+   # additional_tests: 
+   #   android: *test_android
+```