shinyoukai/spyda
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add basic build/usage instructions and create an instance list

Browse Source 
Signed-off-by: Arya Kiran <aryak@vern.cc>
This commit is contained in:
Arya Kiran
2022-10-30 15:48:52 +05:30
committed by James Mills
parent 9beb392905
commit 143cb45fb0
1 changed files with 42 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -1,3 +1,44 @@
# spyda
A privacy first search engine.
A privacy first search engine.
## Building
To build spyda, simply run `make`. The only dependencies you need installed to run the makefile are [go-minify](https://github.com/tdewolff/minify) and golang itself.
## Usage
```
-E, --admin-email string default admin user email (default "support@spyda.dev")
-N, --admin-name string default admin user name (default "Administrator")
-u, --base-url string base url to use (default "http://0.0.0.0:8000")
-b, --bind string [int]:<port> to bind to (default "0.0.0.0:8000")
--cookie-secret string cookie secret to use secure sessions (default "INVALID CONFIG VALUE - PLEASE CHANGE THIS VALUE")
-d, --data string data directory (default "./data")
-D, --debug enable debug logging
-m, --description string set the instance description (default " 🕸 spyda is a privacy first search engine and web crawler.")
-n, --name string set the instance name (default "spyda.dev")
-T, --results-per-page int maximum results per page to display (default 10)
--session-expiry duration timeout for sessions to expire (default 240h0m0s)
--smtp-from string SMTP From to use for email sending (default "INVALID CONFIG VALUE - PLEASE CHANGE THIS VALUE")
--smtp-host string SMTP Host to use for email sending (default "smtp.gmail.com")
--smtp-pass string SMTP Pass to use for email sending (default "INVALID CONFIG VALUE - PLEASE CHANGE THIS VALUE")
--smtp-port int SMTP Port to use for email sending (default 587)
--smtp-user string SMTP User to use for email sending (default "INVALID CONFIG VALUE - PLEASE CHANGE THIS VALUE")
-s, --store string store to use (default "bitcask://spyda.db")
-t, --theme string set the default theme (default "dark")
-v, --version display version information
```
Cookie secret can be generated with `openssl rand -hex 32`
A basic spyda server would look like this: `./spyda --cookie-secret xxx -n "Your Spyda Instance" -s bitcask://./data/spyda.db`
## Instances
| Instance | Country |
|--------------------|----------------------|
| https://spyda.dev | Unknown (Cloudflare) |
| https://sy.vern.cc | Canada |
| http://sy.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion | Canada |
| http://vernbzytqve2yzdud5pndkhwnkhqb2vfjtu7r42tj5savjrabsaq.b32.i2p | Canada |