siddiquezaman / superinsight-db Goto Github PK

Superinsight is a Relational Database for Unstructured Data, its main purpose is to provide a simple SQL interface to store and search unstructured data. Superinsight is build on top of PostgreSQL so you can take advantage of everything in PostgreSQL plus the ability to run machine learning operations using SQL statements.

For guidance on how to use Superinsight, see our User Documentation.

The best way to get started with Superinsight is to build and run our docker image

docker run \
--name superinsight-db-standalone \
-p 5432:5432 \
-e SUPERINSIGHT_USER=admin \
-e SUPERINSIGHT_PASSWORD=password \
superinsight/superinsight-db-standalone:latest

To mount a volumn to the data directory located in the path use the -v argument.

docker run \
--name superinsight-db-standalone \
-p 5432:5432 \
-v vol-superinsight:/db \
-e SUPERINSIGHT_USER=admin \
-e SUPERINSIGHT_PASSWORD=password \
superinsight/superinsight-db-standalone:latest

For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.

Contributions to Superinsight are welcomed. If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!