37 lines
1 KiB
Markdown
37 lines
1 KiB
Markdown
# searpl
|
|
|
|
searpl is a small php search engine with the following features:
|
|
|
|
- [x] robot.txt compliant
|
|
- [x] sqlite, so theres no need to run some fancy database daemon
|
|
- [x] javascript-free
|
|
- [ ] it uses a cloudflare cdn for the search button icon,
|
|
but you can block it without impacting much.
|
|
- [x] read-only database, nothing is written except with the shell
|
|
|
|
|
|
|
|
## licensing
|
|
searpl is licenced under an MIT licence, see [LICENSE](LICENSE)
|
|
for more information
|
|
|
|
## setup
|
|
this guide assumes you have shell access and are comfortable
|
|
using command line tools like git.
|
|
|
|
- make sure you have php, php-pdo, wget, sqlite3 and git installed
|
|
- go in your `htdocs`, `public_html` or whatever and git clone
|
|
this repo
|
|
- `touch db.sqlite` to create the database
|
|
- copy the contents of `create.sql` and paste it into the prompt
|
|
on `sqlite3 db.sqlite` to create the table
|
|
|
|
## crawling
|
|
to crawl a site, do `./urls.sh https://example.com`
|
|
|
|
to recursively crawl, change the recursion limit with -l
|
|
|
|
```
|
|
./urls.sh -l5 https://example.com
|
|
```
|
|
|