README.md (942B)
1 # searpl 2 3 searpl is a small php search engine with the following features: 4 5 - [x] robot.txt compliant 6 - [x] sqlite, so theres no need to run some fancy database daemon 7 - [x] javascript-free 8 - [x] no cdns! 9 - [x] read-only database, nothing is written except with the shell 10 11 12 13 ## licensing 14 searpl is licenced under an MIT licence, see [LICENSE](LICENSE) 15 for more information 16 17 ## setup 18 this guide assumes you have shell access and are comfortable 19 using command line tools like git. 20 21 - make sure you have php, php-pdo, wget, sqlite3 and git installed 22 - go in your `htdocs`, `public_html` or whatever and git clone 23 this repo 24 - `touch db.sqlite` to create the database 25 - copy the contents of `create.sql` and paste it into the prompt 26 on `sqlite3 db.sqlite` to create the table 27 28 ## crawling 29 to crawl a site, do `./urls.sh https://example.com` 30 31 to recursively crawl, change the recursion limit with -l 32 33 ``` 34 ./urls.sh -l5 https://example.com 35 ``` 36