|
|
||
|---|---|---|
| docs | ||
| server | ||
| test | ||
| .babelrc | ||
| .editorconfig | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| chainquery-config.json.example | ||
| CONTRIBUTORS.md | ||
| gendb.sh | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| swagger.json | ||
Lighthouse - A lightning fast search for the LBRY blockchain
Lighthouse is a lightning-fast advanced search engine API for publications on the lbrycrd with autocomplete capabilities. The official lighthouse instance is live at https://lighthouse.lbry.com
What does Lighthouse consist of?
- Elasticsearch as a backend db server.
- LBRYimport, an importer that imports the claims into the Elasticsearch database.
- Lighthouse API server, which serves the API and does all calculations about what to send to the end user.
API Documentation / Usage example
To make a simple search by string:
https://lighthouse.lbry.com/search?s=stringtosearch
To get autocomplete suggestions:
https://lighthouse.lbry.com/autocomplete?s=stringtocomp
Installation
Prerequisites
To get started you should clone the git:
git clone https://github.com/lbryio/lighthouse
Make sure elasticsearch is running and run (from the lighthouse dir):
./gendb.sh
Install dependencies:
npm run install --production=false
Build and run Lighthouse:
npm run prod
You are now up and running! You can connect to lighthouse at http://localhost:50005, api documentation is here. Lighthouse will continue syncing in the background. It usually takes ~15 minutes before all claims are up to date in the database.
Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see lbry.com/faq/contributing
License
This project is MIT Licensed © LBRYio, Filip Nyquist
Security
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it.
Contact
The primary contact for this project is @tiger5226 (beamer@lbry.com)