Getting Started

Requirements

DataVaulture requires:

• A Docker-compatible server
• MySQL or PostgreSQL database for DataVaulture itself
• MySQL or PostgreSQL databases you want to manage

Configuration

DataVaulture uses a JSON configuration file to set the database that DataVaulture uses for its own data. Data sources are added through the web interface.

appSource Configuration

The appSource section in the config file specifies the database that DataVaulture uses to store its own data (users, change requests, audit logs, etc.).

Example Configuration

{
  "appSource": {
    "url": "localhost",
    "username": "datavaulture_app",
    "password": "your-secure-password",
    "type": "Mysql",
    "port": 3306,
    "databaseName": "datavaulture"
  }
}

Managing Data Sources

After logging in, add the databases you want to manage through the Settings → Data Sources page. You can add, edit, or delete data sources directly from the web interface without restarting DataVaulture.

Running with Docker

Save your configuration file as db-config.json with the appSource settings and run:

docker run -d \
  -p 8080:8080 \
  -v /path/to/db-config.json:/db-config.json \
  datavaulture/datavaulture:latest

After DataVaulture starts, log in and add your data sources through the Settings → Data Sources page.

First Login

On first run, DataVaulture creates a default admin user:

• Username: admin
• Password: admin

You will be prompted to change your password on first login.

Registration

To enable user management, you must register your DataVaulture instance. Email [email protected] with the following:

• Name — your name or organization name
• Email — contact email for your account
• Number of users — maximum active user accounts needed
• Domains — comma-separated list of domains your users will log in from

After submitting, you'll receive a license key to activate user management features.

Next Steps

1. Create user accounts for your team
2. Set up roles with appropriate permissions
3. Configure your settings (approval requirements, query limits, etc.)
4. Start making safe, audited database changes