chat-with-knowledge-base/env.example at main · maximhq/chat-with-knowledge-base · GitHub

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
# =============================================================================
# ENVIRONMENT VARIABLES TEMPLATE
# =============================================================================
# Copy this file to .env and fill in your actual values
# NEVER commit .env to git - it contains sensitive information
#
# For local development: cp env.example .env
# For production: Use secrets for sensitive variables
# =============================================================================

# =============================================================================
# 🔴 SENSITIVE VARIABLES
# =============================================================================

# MySQL Database Credentials
MYSQL_ROOT_PASSWORD="your-secure-root-password-here"
MYSQL_PASSWORD="your-secure-user-password-here"

# Authentication Secret (Generate with: openssl rand -base64 32)
AUTH_SECRET="your-super-secure-nextauth-secret-here"

# Email Service (Resend API)
RESEND_API_KEY="re_your_resend_api_key_here"

# Maxim AI Configuration
MAXIM_API_KEY="your-maxim-api-key-here"
MAXIM_LOG_REPO_ID="your-maxim-log-repo-id-here"

# Optional API Keys (leave empty for local development)
QDRANT_API_KEY=""
BIFROST_API_KEY=""

# =============================================================================
# 🟡 ENVIRONMENT-SPECIFIC VARIABLES
# =============================================================================

# Database Connection (will be auto-generated from MySQL credentials)
DATABASE_URL="mysql://${MYSQL_USER:-chatuser}:${MYSQL_PASSWORD}@db:3306/${MYSQL_DATABASE:-chat_kb}"

# Email Configuration
EMAIL_FROM="your-email@yourdomain.com"
ALLOWED_EMAIL_DOMAINS="yourdomain.com,gmail.com"

# =============================================================================
# 🟢 NON-SENSITIVE CONFIGURATION (Safe to keep in docker-compose.yml)
# =============================================================================

# MySQL Database Configuration
MYSQL_DATABASE="chat_kb"
MYSQL_USER="chatuser"

# Service URLs (for Docker Compose)
BIFROST_API_URL="http://bifrost:8080"
QDRANT_URL="http://qdrant:6333"

# File Upload Configuration
UPLOAD_DIR="/app/uploads"
MAX_FILE_SIZE="10485760"

# Application Configuration
NODE_ENV="development"
PORT="3000"

# =============================================================================
# 📝 SETUP INSTRUCTIONS
# =============================================================================
#
# 1. Copy this file: cp env.example .env
# 2. Fill in all the SENSITIVE variables above
# 3. Update EMAIL_FROM and ALLOWED_EMAIL_DOMAINS for your domain
# 4. Generate AUTH_SECRET: openssl rand -base64 32
# 5. Get RESEND_API_KEY from https://resend.com/
# 6. Get MAXIM_API_KEY from your Maxim AI dashboard
#
# For production deployment:
# - Use secrets set for all SENSITIVE variables
# - Set NODE_ENV=production
#
# =============================================================================