Welcome to the PeARS documentation!
NB: this documentation is work in progress. Check back in later!
PeARS (the People’s Agent for Reciprocated Search) is a free search engine that you can run locally from your browser, or from your own server. It allows you to ‘index’ pages (i.e. to produce a computer-readable representation of the pages’ content, essential to the search process), and to search pages that you or your friends have indexed. In a local setting, search happens entirely on your machine, meaning that no one knows what you are searching and when. In a decentralised setting, you and your friends can get together to maintain an search engine that you have entire control over.
If you are excited about the idea of a decentralised search engine, there are different ways you can contribute! Find out what you can do as:
If you want to run your own PeARS, either locally or as a public instance, check out the Installation section for further information on setting up the software.
Note
This project is under active development.
Contents
- What type of PeARS contributor are you?
- Installation
- Install from source
- Install from docker
- 1. Deploy Docker and Docker Compose
- 2. Deploy PeARS-federated
- Download the Docker-compose file and setup base directory for your instance
- Configure the environmental details for your instance
- Bring Up the Docker Compose
- Point your DNS to the IP address of the server
- 3. (Optional) Adding more instances to the same server
- 4. Management
- The PeARS .env
- Tutorial 1: index Wikipedia pages
- Tutorial 2: Training a PeARS model for your language
- Tutorial 3: Use PeARS with the On My Disk private cloud solution