Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 2.85 KB

README.md

File metadata and controls

105 lines (73 loc) · 2.85 KB
Raw

Build Status Coverage Status Go Report Card

Omniscience is a search utility for searching over private documents aggregated from a collection of sources.

+----------+
|Google    |
|Drive     | --+
|Service   |   |
+----------+   |
               |
+----------+   |    +----------+     +----------+     +----------+                       
|GitHub    |   |    |Ingestion |     |DB        |     |Frontend  |                   
|Service   | --+--> |Service   | --> |          | --> |          |
|          |   |    |          |     |          |     |          |
+----------+   |    +----------+     +----------+     +----------+
               |
+----------+   |
|Confluence|   |
|Service   | --+
|          |
+----------+

Elasticsearch

Install

$ brew update
$ brew install elasticsearch

Using local ES server

To avoid getting a cors related error when connecting the UI to your local elasticsearch instance, add the following to your config/elasticsearch.yml file (if you installed Elasticsearch using brew, this file can be found at /usr/local/Cellar/elasticsearch/6.2.2/libexec/config/elasticsearch.yml).

http.cors.enabled : true  
http.cors.allow-origin : "*"
http.cors.allow-methods : OPTIONS, HEAD, GET, POST, PUT, DELETE
http.cors.allow-headers : X-Requested-With,X-Auth-Token,Content-Type, Content-Length

Start local ES server

$ elasticsearch

Golang backend

Start Go server

To start the omniscience server, run

$ go run cmd/omniscience_server/main.go --fGoogleServiceAccountPath=<path-to-service-account-json>

from the root of the project.

Manually invoke indexing

Indexing is invoked on a per service basis. To index files from a given service navigate to the service's directory in the cmd/omniscience_client directory and run

$ go run main.go

with the relevant flags for the service. More detailed instructions for running each service can be found in the README of each service's directory.

Elasticsearch and the omniscience server must be running for indexing to work.

React app

Install dependencies

From the project root run:

$ cd client && npm i

Start local node server

From the project root run:

$ cd client && npm start

Search everything!

Navigate to http://localhost:3000

License

This project is licensed under the MIT License - see the LICENSE.md file for details