From 816c883f300e617bfe073a0e0ebbbce17d7dc26c Mon Sep 17 00:00:00 2001 From: Naiyuan Qing <145280634+NevilleQingNY@users.noreply.github.com> Date: Thu, 12 Feb 2026 19:00:04 +0800 Subject: [PATCH] docs(desktop): improve .env.example with accurate configuration guide - 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 --- apps/desktop/.env.example | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/apps/desktop/.env.example b/apps/desktop/.env.example index 25b5317f..ee9e562e 100644 --- a/apps/desktop/.env.example +++ b/apps/desktop/.env.example @@ -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