Giter Club home page Giter Club logo

lighthouse's Introduction

Lighthouse - A lightning fast search for the LBRY blockchain

Codacy Badge MIT licensed

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?

  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 / 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):

./dev.sh

You are now up and running! You can connect to lighthouse at http://localhost:50005. Lighthouse will continue syncing in the background. It usually takes ~15 minutes before all claims are up to date in the database.

F.A.Q

If you get the following error that contains

To resolve this error you will want to access the dev console of Kibana and run the following query to unlock the index FORBIDDEN/12/index read-only / allow delete (api)]. It commonly happens when you runing out of disk space and elastic search will lock the index from changes.

PUT claims/_settings
{
  "index": {
    "blocks": {
      "read_only_allow_delete": "false"
    }
  }
}

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

Security

We take security seriously. Please contact [email protected] regarding any security issues. Our PGP key is here if you need it.

Contact

The primary contact for this project is @tiger5226 ([email protected])

lighthouse's People

Contributors

ioancole avatar kauffj avatar peterdavehello avatar tiger5226 avatar tzarebczan avatar ykris45 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.