Merge pull request #44 from vfioox/master

typos, pointing to wrong url
This commit is contained in:
filipnyquist 2017-12-28 20:36:19 +01:00 committed by GitHub
commit edbd0bc46c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -3,11 +3,11 @@
## What is Lighthouse? ## What is Lighthouse?
>Lighthouse is a lightning-fast advanced search engine API for publications on the lbrycrd with autocomplete capabilities. >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 >The official lighthouse instance is live at https://lbryio.github.io/lighthouse/
## What does Lighthouse consist of? ## What does Lighthouse consist of?
>1. Elasticsearch as a backend db server. >1. Elasticsearch as a backend db server.
>2. LBRYimport, a importer that imports the claims into the Elasticsearch database. >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. >3. Lighthouse API server, which serves the API and does all calculations about what to send to the end user.
## API Documentation ## API Documentation
@ -30,7 +30,7 @@ git clone https://github.com/lbryio/lighthouse
[Download lbrycrd](https://github.com/lbryio/lbrycrd/releases) [Download lbrycrd](https://github.com/lbryio/lbrycrd/releases)
>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. >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): >Make sure elasticsearch is running and run (from the lighthouse dir):
``` ```
./gendb.sh ./gendb.sh
``` ```
@ -38,7 +38,7 @@ git clone https://github.com/lbryio/lighthouse
``` ```
yarn install --production=false yarn install --production=false
``` ```
>Start a instance of the decoder: >Start an instance of the decoder:
``` ```
cd decoder && pip install -r requirements.txt && python decoder.py cd decoder && pip install -r requirements.txt && python decoder.py
``` ```
@ -47,7 +47,7 @@ cd decoder && pip install -r requirements.txt && python decoder.py
yarn run prod yarn run prod
``` ```
>WOO! You are now up and running! You can connect to lighthouse at http://localhost:50005, api documentation is [here](https://lbryio.github.io/lighthouse/). >WOO! You are now up and running! You can connect to lighthouse at http://localhost:50005, api documentation is [here](https://lbryio.github.io/lighthouse/).
Lighthouse will continue syncing in the background so it could take approx 10-15minutes before all claims are up to date in database. Lighthouse will continue syncing in the background, usually takes 10-15 minutes before all claims are up to date in the database.
## License ## License
MIT © [LBRYio, Filip Nyquist](https://github.com/lbryio) MIT © [LBRYio, Filip Nyquist](https://github.com/lbryio)