LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Lighthouse - A lightning fast search for the LBRY blockchain
92 commits 4 branches 0 tags 3.6 MiB
JavaScript 98.5%
Shell 1.5%
Find a file
filipnyquist ec89049049
Merge pull request #65 from lbryio/pagination 
Added size for number of results to get and from for pagination.
2018-04-27 07:48:22 +02:00
decoder Removed configuration of decoder, using lbrycrd conf from .lbrycrd. 2017-09-26 17:51:18 +02:00
docs Updated apidocs to use HTTPS for github pages. 2018-04-08 09:39:40 +02:00
server Added size for number of results to get and from for pagination. 2018-04-26 20:11:18 -04:00
test Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.babelrc Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.editorconfig Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.eslintrc Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.gitignore ignore claimTrieCache 2017-09-22 18:33:31 -04:00
apidoc.json Updated apidocs to use HTTPS for github pages. 2018-04-08 09:39:40 +02:00
CONTRIBUTORS.md Added contributors 2017-09-20 13:17:48 +02:00
gendb.sh Made ./gendb.sh idempotent. 2017-09-26 17:52:05 +02:00
LICENSE create LICENSE file 2018-02-05 13:04:58 -08:00
package.json Updated API docs to fix documentation errors on github pages which is the target of the documentation. The main culprit was not having cors enabled to handle the same origin policy of the browsers. With the koa-cors package now enabled this will work perfectly. 2018-04-08 02:13:27 -04:00
README.md Update README.md 2018-04-19 22:53:10 +02:00
yarn.lock Updated apidocs to use HTTPS for github pages. 2018-04-08 09:39:40 +02:00

README.md

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.io

What does Lighthouse consist of?

  1. Elasticsearch as a backend db server.
  2. LBRYimport, an importer that imports the claims into the Elasticsearch database.
  3. Lighthouse API server, which serves the API and does all calculations about what to send to the end user.

API Documentation

The full API documentation

Installation

Prerequisites

To get started you should clone the git:

git clone https://github.com/lbryio/lighthouse

Grab the latest release of lbrycrd here:

Download lbrycrd

Create a lbrycrd config file at ~/.lbrycrd/lbrycrd.conf which contains rpcuser,rpcpassword and rpcport. Then run lbrycrd in the background with that config file.

Make sure elasticsearch is running and run (from the lighthouse dir):

./gendb.sh

Install dependencies:

yarn install --production=false

Start an instance of the decoder:

cd decoder && pip install -r requirements.txt && python decoder.py

Build and run Lighthouse:

yarn 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.io/faq/contributing

License

This project is MIT Licensed © LBRYio, Filip Nyquist

Contact

The primary contact for this project is @filipnyquist (filip@lbry.io)