Skip to content
This repository has been archived by the owner on Nov 30, 2024. It is now read-only.

Commit

Permalink
Updating the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzonthemtn committed Mar 23, 2024
1 parent ac6109a commit 7cafa3b
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

EntityDB is an application that integrates several components to provide a unified means for storing and querying entities (people, places, and things). This project includes the Entity Query Language (EQL) which facilitates querying entities across various underlying databases through a single query language.

As EntityDB matures and gets closer to a 1.0 release, the project's goals are to provide a means for storing and querying entities that's scalable, efficient, and useful to the community.

For help using and configuring EntityDB please see the [docs](https://github.com/philterd/docs).

## Architectural Overview
## Architecture

Entities are stored in an underlying database. Supported databases are MySQL, MongoDB, Cassandra, and DynamoDB. Entities are indexed in Elasticsearch for fast querying. A cache stores recently ingested and accessed entities to improve performance. A separate database, the data store, manages data such as users, groups, queries, and other information.

Expand Down Expand Up @@ -64,10 +60,6 @@ mvn clean install

Once successfully built, an `entitydb.jar` will be under `entitydb-app/target`. This is a runnable jar that can be started with `java -jar entitydb.jar`. By default, all components will use internal implementations but this can be changed in the `entitydb.properties`. See the [Documentation](https://github.com/mtnfog/entitydb/blob/master/documentation.md) for details on configuring the `entitydb.properties`.

## Deploying

Refer to the [wiki](https://github.com/mtnfog/entitydb/wiki/Deploying) for detailed deployment instructions. Scripts are included under the `scripts/packaging/` directory to create an AMI (Packer script), a Docker container, and a CloudFormation stack.

### Ingesting Entities

#### Via the REST API
Expand Down

0 comments on commit 7cafa3b

Please sign in to comment.