lighthouse.js/README.md
filipnyquist 7b53c3a068 Updated documentation with more information!
Updated README.md with instructions on how to run and some license fixes!
2017-10-16 22:26:13 +02:00

1.8 KiB

Lighthouse - A lightning fast search for the LBRY blockchain

Created by filipnyquist filip@lbry.io and the community!

What is Lighthouse?

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, a 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

Running Lighthouse

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 a instance of the decoder:

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

Build and run Lighthouse:

yarn run prod

WOO! 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 so it could take approx 10-15minutes before all claims are up to date in database.

License

MIT © LBRYio, Filip Nyquist