searpl/README.md

942 B

searpl

searpl is a small php search engine with the following features:

  • robot.txt compliant
  • sqlite, so theres no need to run some fancy database daemon
  • javascript-free
  • no cdns!
  • read-only database, nothing is written except with the shell

licensing

searpl is licensed under an MIT licence, see 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