Add .env.example templates for desktop app and Rust backend (#5357)

Author: beastoin

desktop/.env.example

@@ -0,0 +1,29 @@
+# Desktop macOS App — Environment Variables
+# Copy to desktop/Backend-Rust/.env (loaded by run.sh into the app bundle)
+#
+# The Swift app reads .env from these locations (first match wins):
+#   1. App bundle: Contents/Resources/.env
+#   2. Current directory: ./.env
+#   3. Home directory: ~/.omi.env
+#
+# run.sh automatically copies Backend-Rust/.env into the app bundle.
+
+# ─── Required ────────────────────────────────────────────────────────
+
+# Backend API URL — where the Rust backend is running
+# Local dev:  http://localhost:8080
+# VPS dev:    http://<tailscale-ip>:9080
+# Cloud Run:  https://desktop-backend-dt5lrfkkoa-uc.a.run.app
+# Production: https://api.omi.me
+OMI_API_URL=http://localhost:8080
+
+# DeepGram API key — required for real-time transcription
+DEEPGRAM_API_KEY=
+
+# ─── AI (optional) ──────────────────────────────────────────────────
+# Gemini API key for proactive assistants and embeddings
+# Falls back to backend-side processing if not set
+GEMINI_API_KEY=
+
+# ─── Analytics (optional) ───────────────────────────────────────────
+# MIXPANEL_PROJECT_TOKEN=

desktop/.gitignore

@@ -10,6 +10,7 @@ DerivedData/
 
 # Environment (both contain secrets)
 .env
+!.env.example
 .env.app
 .env.app.dev
 

desktop/Backend-Rust/.env.example

@@ -0,0 +1,62 @@
+# Desktop Rust Backend — Environment Variables
+# Copy to .env and fill in values from GCP Secret Manager:
+#   gcloud secrets versions access latest --secret=<NAME> --project=based-hardware-dev
+#
+# IMPORTANT: Single-quote passwords that contain $ characters to prevent
+# dotenvy variable expansion (e.g. PASSWORD='my$ecret')
+
+# ─── Server ──────────────────────────────────────────────────────────
+PORT=8080
+
+# ─── Firebase / Firestore ────────────────────────────────────────────
+# Project ID determines which Firestore database to use
+FIREBASE_PROJECT_ID=based-hardware-dev
+# Path to GCP service account JSON (must have Firestore + Compute access)
+GOOGLE_APPLICATION_CREDENTIALS=/path/to/google-credentials.json
+# Firebase Web API key (for identity toolkit / auth token exchange)
+FIREBASE_API_KEY=
+
+# ─── AI ──────────────────────────────────────────────────────────────
+GEMINI_API_KEY=
+
+# ─── Encryption ──────────────────────────────────────────────────────
+# Used to decrypt user data with enhanced protection level
+ENCRYPTION_SECRET=
+
+# ─── Redis ───────────────────────────────────────────────────────────
+# Used for conversation visibility, task sharing, app install counts
+REDIS_DB_HOST=
+REDIS_DB_PORT=6379
+REDIS_DB_PASSWORD=
+
+# ─── Pinecone (vector embeddings) ────────────────────────────────────
+PINECONE_API_KEY=
+PINECONE_HOST=
+
+# ─── AgentVM (GCE provisioning) ─────────────────────────────────────
+# All optional — defaults derived from FIREBASE_PROJECT_ID
+# GCE_PROJECT_ID=                 # defaults to FIREBASE_PROJECT_ID
+# GCE_SOURCE_IMAGE=               # defaults to projects/{project}/global/images/family/omi-agent
+# AGENT_GCS_BUCKET=               # defaults to based-hardware-agent
+
+# ─── OAuth (optional, for desktop sign-in) ───────────────────────────
+# BASE_API_URL=
+# APPLE_CLIENT_ID=
+# APPLE_TEAM_ID=
+# APPLE_KEY_ID=
+# APPLE_PRIVATE_KEY=
+# GOOGLE_CLIENT_ID=
+# GOOGLE_CLIENT_SECRET=
+
+# ─── Observability (optional) ───────────────────────────────────────
+# RUST_LOG=debug
+# POSTHOG_PERSONAL_API_KEY=
+# POSTHOG_PROJECT_ID=302298
+# SENTRY_WEBHOOK_SECRET=
+# SENTRY_AUTH_TOKEN=
+# SENTRY_ADMIN_UID=
+
+# ─── Crisp (optional, customer support) ─────────────────────────────
+# CRISP_PLUGIN_IDENTIFIER=
+# CRISP_PLUGIN_KEY=
+# CRISP_WEBSITE_ID=

desktop/Backend-Rust/.gitignore

@@ -1,4 +1,5 @@
 /target
 .env
+!.env.example
 *.log
 .DS_Store