Get Started

1) Set up your infrastructure

In order to get DataVaulture up and running you will need to set up a Docker compatible server and either a MySql or PostgreSql database to support it.

2) Create config file

Create a config file to give DataVaulture access to all database you wish as well as configure its own database. Below is an example file.

{
        "appSource": { // this is the config to your DataVauture's instance
                "url": "url-to-your-db",
                "username": "username-of-your-db",
                "password": "password-of-your-db",
                "type": "db-type", // either Mysql or Postgresql
                "port": "port-for-your-db",
                "databaseName": "the-schema-name-within-your-db"
        },

        "sources": // this is a list of all databases you want your users to have access to within the DataVaulture app
                [
                        {
                                "id": "a-unique-id-defined-by-you",
                                "displayName": "a-user-friendly-db-name",
                                "type": "db-type", // either Mysql or Postgresql
                                "url": "a-url-to-one-of-your-dbs",
                                "username": "the-username-for-this-db",
                                "password": "the-password-for-this-db",
                                "port": "the-port-for-this-db",
                                "databaseName": "the-database-name-for-this-db" // only needed for PostgreSQL
                        },
                        {
                                "id": "a-different-unique-id-defined-by-you",
                                "displayName": "a-different-user-friendly-db-name",
                                "type": "db-type", // either Mysql or Postgresql
                                "url": "a-different-url-to-one-of-your-dbs",
                                "username": "the-username-for-this-db",
                                "password": "the-password-for-this-db",
                                "port": "the-port-for-this-db",
                                "databaseName": "the-database-name-for-this-db" // only needed for PostgreSQL
                        },
                        
                        // etc
                ]
}

3) Create dockerfile

The dockerfile needs the DataVaulture base image and a copy of the config file created from step 2. Below is an example

FROM datavaulture/datavaulture:latest
COPY your-config-from-previous-step.json /db-config.json
CMD ["java", "-jar", "/app.jar"]

4) Run the app

Start the app up. Once started you can log in via the admin. The username is admin and the password is password.

5) Register

To allow for additional users to have access to DataVaulture you must register.

Search