marketing-shibata50/multica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(desktop): improve .env.example with accurate configuration guide

Browse source 
- Clarify that local dev needs no .env (GATEWAY_URL set in package.json)
- Document GATEWAY_URL override for local gateway testing
- Add detailed explanation of both URLs (Gateway vs API Server)
- List dev/prod values for each environment variable

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Naiyuan Qing 2026-02-12 19:00:04 +08:00
parent 71433fc4ed
commit 816c883f30
1 changed files with 24 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

36
apps/desktop/.env.example
View file

@ -2,22 +2,34 @@
# Multica Desktop Environment Configuration
# =============================================================================
#
# Copy this file to create environment-specific configs:
# .env.development - Local development (npm run dev)
# .env.staging - Test environment (npm run build --mode staging)
# .env.production - Production release (npm run build)
# Local Development:
# `pnpm dev` connects to dev gateway by default (GATEWAY_URL set in root package.json)
# No .env file needed for local development.
# To override: GATEWAY_URL=http://localhost:3000 pnpm dev
#
# Production Build:
# `pnpm build` uses .env.production automatically
#
# Variable naming convention:
# MAIN_VITE_* - Available in main process only
# RENDERER_VITE_* - Available in renderer process only
# VITE_* - Available in all processes
# MAIN_VITE_* - Main process only (Node.js, full system access)
# RENDERER_VITE_* - Renderer process only (browser context)
# VITE_* - All processes
#
# =============================================================================
# URL Configuration
# =============================================================================
#
# MAIN_VITE_GATEWAY_URL - WebSocket Gateway
# Hub connects to Gateway for remote device access (QR code pairing)
# Dev: https://multica-dev.copilothub.ai (default via package.json)
# Prod: https://gateway.multica.ai
#
# MAIN_VITE_MULTICA_URL - REST API Server
# HTTP requests for authentication, auto-updates, user data sync
# Dev: https://multica-dev.copilothub.ai
# Prod: https://api.multica.ai
#
# =============================================================================
# Gateway WebSocket server URL
# Used for Hub <-> Gateway communication
MAIN_VITE_GATEWAY_URL=http://localhost:3000
# Multica API server URL
# Used for HTTP API requests (auth, updates, etc.)
MAIN_VITE_MULTICA_URL=http://localhost:3001