0.0.3

1 files changed, 30 insertions, 0 deletions

diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..76cabab
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,30 @@
+sear.c for Debian
+
+sear.c is used as a lightweight replacement for SearX that proxies and caches
+search results from the Google web search engine. The main advantages over
+SearX are speed and simplicity.
+
+* run the daemon - it starts listening on HTTP port 7327 (remember it by
+	picturing phone keyboard buttons with letters SEAR (; )
+* optional: create a reverse proxy for HTTPS
+* navigate to http://localhost:7327 and do a couple of searches to see if
+	everything works
+* the horseshoe button redirects directly to the first result without wasting
+	time on the results page. use if you feel lucky. (BP)
+* check logs by navigating to /logs.html
+
+It's not recommended to run a public instance of sear.c yet, as google likes
+to prevent spam by using a captcha.
+
+It's expected that I'll write a simple captcha forwarder so that users of public
+instances will solve captchas that are presented and keep the instance healthy.
+
+Currently it's recommended to run private instances, protected by a password
+using a reverse HTTP proxy.
+
+systemd users can start with service sear.c start
+
+please also read the README.md file in the git repository or via web:
+  http://git.sijanec.eu/sijanec/sear.c/src/branch/master/README.md
+
+ -- Anton Luka Šijanec <anton@sijanec.eu>  Sun, 04 Apr 2021 16:00:00 +0200