multica/apps/desktop/.env.example
Naiyuan Qing 5c5ac76693 docs(desktop): add build commands and configuration guide to .env.example
- Add build commands section with dev/staging/production options
- Add build output section explaining release directory structure
- Add configuration guide for production builds
- Add variable naming convention explanation
- Improve environment variables documentation with examples

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-13 17:55:44 +08:00

74 lines
3 KiB
Text

# =============================================================================
# Multica Desktop Environment Configuration
# =============================================================================
#
# This file documents all available environment variables for Desktop builds.
# Copy this file and rename it based on your target environment.
#
# =============================================================================
# Build Commands
# =============================================================================
#
# Development (no .env file needed):
# pnpm dev # Uses hardcoded dev defaults
#
# Staging Build:
# pnpm build:staging # Uses .env.staging
#
# Production Build:
# pnpm build:production # Uses .env.production
#
# Default Build (uses .env.production):
# pnpm build:desktop # Same as build:production
#
# =============================================================================
# Build Output
# =============================================================================
#
# After build completes, installer packages are located at:
#
# apps/desktop/release/{version}/
# ├── Multica-{version}-arm64.dmg # macOS Apple Silicon
# ├── Multica-{version}-x64.dmg # macOS Intel
# ├── Multica-Windows-{version}-Setup.exe # Windows
# ├── Multica-Linux-{version}.AppImage # Linux AppImage
# └── Multica-Linux-{version}.deb # Linux deb
#
# Compiled code (before packaging) is in:
# apps/desktop/out/
#
# =============================================================================
# Configuration Guide
# =============================================================================
#
# For production builds, create .env.production with the following variables:
#
# Required:
# MAIN_VITE_GATEWAY_URL - WebSocket Gateway URL for remote connections
# MAIN_VITE_WEB_URL - Web App URL for OAuth login flow
#
# Example .env.production:
# MAIN_VITE_GATEWAY_URL=https://gateway.multica.ai
# MAIN_VITE_WEB_URL=https://www.multica.ai
#
# =============================================================================
# Variable Naming Convention
# =============================================================================
#
# MAIN_VITE_* - Main process only (Node.js, full system access)
# RENDERER_VITE_* - Renderer process only (browser context)
# VITE_* - All processes
#
# =============================================================================
# Environment Variables
# =============================================================================
# MAIN_VITE_GATEWAY_URL
# WebSocket Gateway URL - Hub connects here for remote device access (QR code pairing)
# Production example: https://gateway.multica.ai
MAIN_VITE_GATEWAY_URL=http://localhost:3000
# MAIN_VITE_WEB_URL
# Web App URL - Desktop opens this URL for user login (OAuth flow)
# Production example: https://www.multica.ai
MAIN_VITE_WEB_URL=http://localhost:3000