Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
123 lines (107 loc) · 5.13 KB
/
Copy path.env.example
File metadata and controls
123 lines (107 loc) · 5.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# ==============================================================================
# db-studio Environment Configuration
# Copy this file to .env and configure for your local environment:
# cp .env.example .env
# ==============================================================================
# ------------------------------------------------------------------------------
# 1. Database Connection (Required)
# ------------------------------------------------------------------------------
# Primary database connection string used by db-studio server and CLI.
# Supported database types: PostgreSQL, CockroachDB, MySQL, MariaDB, TiDB, SQL Server (MSSQL),
# MongoDB, SQLite / libSQL (Turso), Redis, DuckDB, Oracle, ClickHouse.
#
# Examples by database engine:
#
# PostgreSQL:
# DATABASE_URL="postgresql://postgres:postgres@localhost:5432/dbstudio"
#
# CockroachDB (uses the PostgreSQL adapter):
# DATABASE_URL="cockroachdb://root@localhost:26257/dbstudio"
#
# MySQL:
# DATABASE_URL="mysql://root@localhost:3306/dbstudio"
#
# MariaDB (uses the MySQL adapter):
# DATABASE_URL="mariadb://root@localhost:3307/dbstudio"
#
# TiDB (uses the MySQL adapter):
# DATABASE_URL="tidb://root@localhost:4000/dbstudio"
#
# SQL Server (MSSQL):
# DATABASE_URL="mssql://sa:DbStudio1!@localhost:1433/dbstudio"
#
# MongoDB:
# DATABASE_URL="mongodb://localhost:27017/dbstudio"
#
# SQLite (relative or absolute file path):
# DATABASE_URL="sqlite://./db/dbstudio.sqlite"
#
# libSQL / Turso (local sqld needs ?tls=0 and an explicit port):
# DATABASE_URL="libsql://my-db-my-org.turso.io?authToken=YOUR_TOKEN"
# DATABASE_URL="libsql://127.0.0.1:18080?tls=0"
#
# Redis (database index 0..N):
# DATABASE_URL="redis://localhost:6379/0"
#
# DuckDB (relative or absolute file path):
# DATABASE_URL="duckdb://./db/dbstudio.duckdb"
#
# Oracle (service name as the path):
# DATABASE_URL="oracle://dbstudio:dbstudio@localhost:1521/FREEPDB1"
#
# ClickHouse (HTTP interface; use clickhouses:// for TLS, default port 8443):
# DATABASE_URL="clickhouse://dbstudio:dbstudio@localhost:8123/dbstudio"
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/dbstudio"
# ------------------------------------------------------------------------------
# 2. Server Configuration (Optional)
# ------------------------------------------------------------------------------
# Port for the Hono API server (default: 3333, or dynamically assigned by Portless)
# PORT=3333
# Host to bind the API server to (default: 127.0.0.1; Docker image: 0.0.0.0)
# HOST=127.0.0.1
# Extra hostnames or IPs accepted in requests when serving on your network.
# Localhost is always allowed. Use comma-separated names without ports or wildcards;
# put IPv6 addresses in brackets, for example [fd00::1].
# ALLOWED_HOSTS=db.lan,10.0.0.5
# Password the browser asks for (any username) when HOST is not loopback.
# Unset: a new one is generated and printed at every start.
# DB_STUDIO_PASSWORD=
# Node environment: development | production | test
# NODE_ENV=development
# Explicit cross-origin deployment override (comma-separated list of allowed CORS origins).
# Not needed for local development: when NODE_ENV=development, localhost,
# *.localhost, and 127.0.0.1 origins are permitted automatically on any port
# (including custom Portless ports such as :1355). Only set this to allow
# additional origins, for example in non-development environments:
# ALLOWED_ORIGINS=https://web.db-studio.localhost:1355,https://web.db-studio.localhost
# Public URL of the db-studio server (used for CLI logs and automatic browser opening)
# DB_STUDIO_SERVER_URL="https://api.db-studio.localhost"
# URL of the AI proxy service (defaults to https://proxy.db-studio.localhost in dev,
# or Cloudflare Workers proxy in production)
# DB_STUDIO_PROXY_URL="https://proxy.db-studio.localhost"
# ------------------------------------------------------------------------------
# 3. AI Proxy / Assistant (packages/proxy - Optional)
# ------------------------------------------------------------------------------
# Google Gemini API key used by the proxy to power AI-assisted SQL query generation
# GEMINI_API_KEY=""
# Upstash Redis REST credentials for proxy rate-limiting
# UPSTASH_REDIS_REST_URL=""
# UPSTASH_REDIS_REST_TOKEN=""
# ------------------------------------------------------------------------------
# 4. Web Frontend (packages/web - Optional)
# ------------------------------------------------------------------------------
# Base API URL used by the web client in development (defaults to https://api.db-studio.localhost)
# VITE_API_URL="https://api.db-studio.localhost"
# Vite dev proxy target (defaults to https://api.db-studio.localhost)
# VITE_API_PROXY_TARGET="https://api.db-studio.localhost"
# Enable TanStack Router DevTools server bus ("true" or "false")
# VITE_TANSTACK_SERVER_BUS="false"
# Monitoring & analytics (optional)
# VITE_SENTRY_DSN=""
# VITE_POSTHOG_KEY=""
# VITE_POSTHOG_HOST="https://eu.i.posthog.com"
# DB_STUDIO_SENTRY_DSN=""
# DB_STUDIO_POSTHOG_KEY=""
# DB_STUDIO_POSTHOG_HOST="https://eu.i.posthog.com"
# DB_STUDIO_TELEMETRY="1" # Set to 0 to enforce telemetry off for the installation
# DB_STUDIO_DATA_DIR="" # Optional directory for the anonymous installation state