summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsijanec <anton@sijanec.eu>2021-04-03 23:31:02 +0200
committersijanec <anton@sijanec.eu>2021-04-03 23:31:02 +0200
commit44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb (patch)
tree0b017c90b35c0666ab74c93605a9b9c10a263070
parentinitial release (diff)
downloadsear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar.gz
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar.bz2
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar.lz
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar.xz
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.tar.zst
sear.c-44dbcd3e3eb64e6d3fca8a12e88abc400d653dbb.zip
Diffstat (limited to '')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index ad87bc8..03cf180 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
# sear.c
-**not implemented! check back again in a couple of days (:**
-
-sear.c is used as a lightweight replacement for [SearX](https://en.wikipedia.org/wiki/Searx) that proxies and caches search results from
-the Google web search engine. The main advantages over SearX are speed and simplicity.
+sear.c is used as a lightweight replacement for [SearX](https://en.wikipedia.org/wiki/Searx) that proxies and caches search results
+from the Google web search engine. The main advantages over SearX are speed and simplicity.
## instructions for debian and ubuntu systems
@@ -31,6 +29,14 @@ make prepare
make
```
+## instructions
+
+* 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](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
+
## a word about public instances
It's not recommended to run a public instance of sear.c yet, as google likes to prevent spam by using a captcha.