DocumentationDatabase ServiceGetting Started

Getting Started

Set up your first database instance in minutes with our step-by-step guide

Prerequisites

System Requirements

  • Node.js 16 or higher
  • npm or yarn package manager
  • Internet connection
  • Command line access

Account Setup

  • VPN Enterprise account
  • Database service enabled
  • Valid payment method

Step-by-Step Setup

1
Install CLI Tool
Download and install the VPN Enterprise Database CLI
2 minutes
Install via npm
npm install -g @vpn-enterprise/db-cli
Verify installation
db-cli --version
✅ Validation

Run this command to verify the step completed successfully:

db-cli auth status
2
Authenticate
Log in to your VPN Enterprise account
1 minute
Login with credentials
db-cli auth login --email your@email.com
Or use API key
db-cli auth login --api-key YOUR_API_KEY
✅ Validation

Run this command to verify the step completed successfully:

db-cli auth whoami
3
Create Database
Deploy your first database instance
3-5 minutes
Create PostgreSQL database
db-cli create --type postgresql --name my-first-db --plan starter
Check deployment status
db-cli status my-first-db
✅ Validation

Run this command to verify the step completed successfully:

db-cli list --status running
4
Connect Application
Get connection details and connect your application
2-3 minutes
Get connection string
db-cli connection-string my-first-db
Test connection
db-cli test-connection my-first-db
✅ Validation

Run this command to verify the step completed successfully:

db-cli ping my-first-db

Quick Start Templates

Node.js + PostgreSQL
JavaScriptPostgreSQL
Express.js application with PostgreSQL database
Framework

Express.js

Features Included
JWT Authentication
REST API
Database migrations
Deploy Command
db-cli template deploy nodejs-postgres --name my-app
Python + PostgreSQL
PythonPostgreSQL
FastAPI application with PostgreSQL and SQLAlchemy
Framework

FastAPI

Features Included
Async/await
OpenAPI docs
Database ORM
Deploy Command
db-cli template deploy python-postgres --name my-app
React + MongoDB
JavaScriptMongoDB
React frontend with Node.js backend and MongoDB
Framework

React + Node.js

Features Included
Real-time updates
Document storage
GraphQL API
Deploy Command
db-cli template deploy react-mongodb --name my-app
Next.js + MySQL
TypeScriptMySQL
Full-stack Next.js application with MySQL database
Framework

Next.js

Features Included
Server components
API routes
Prisma ORM
Deploy Command
db-cli template deploy nextjs-mysql --name my-app

Choose Your Plan

Starter
$19/month
Perfect for growing applications
Databases:
Up to 3
Storage:
10 GB
Connections:
100
Backups:
Daily
Support:
Community
Features
Basic monitoring
SSL encryption
Point-in-time recovery
Recommended
Pro
$49/month
Perfect for growing applications
Databases:
Up to 10
Storage:
100 GB
Connections:
500
Backups:
Hourly
Support:
Standard
Features
Advanced monitoring
Read replicas
Connection pooling
Performance insights
Enterprise
$199/month
Perfect for growing applications
Databases:
Unlimited
Storage:
1 TB
Connections:
2000
Backups:
Continuous
Support:
Priority
Features
Multi-region
High availability
Custom configurations
Dedicated support

Common Issues

Installation fails

Ensure Node.js version 16+ is installed. Try using sudo for global npm installs.

sudo npm install -g @vpn-enterprise/db-cli

Next Steps

Now that you have your database running, learn how to optimize connections, configure backups, and scale your infrastructure.