Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .env.secrets.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# ========================================
# Friend-Lite Secrets Template
# ========================================
# Copy this file to .env.secrets and fill in your actual values
# .env.secrets is gitignored and should NEVER be committed
#
# Usage: cp .env.secrets.template .env.secrets

# ========================================
# AUTHENTICATION & SECURITY
# ========================================

# JWT secret key - make this random and long
AUTH_SECRET_KEY=your-super-secret-jwt-key-change-this-to-something-random

# Admin account credentials
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=change-this-secure-password

# ========================================
# LLM API KEYS
# ========================================

# OpenAI API key
OPENAI_API_KEY=sk-your-openai-key-here

# Mistral API key (optional - only if using Mistral transcription)
MISTRAL_API_KEY=

# Groq API key (optional - only if using Groq as LLM provider)
GROQ_API_KEY=

# ========================================
# SPEECH-TO-TEXT API KEYS
# ========================================

# Deepgram API key
DEEPGRAM_API_KEY=your-deepgram-key-here

# ========================================
# SPEAKER RECOGNITION
# ========================================

# Hugging Face token for speaker recognition models
HF_TOKEN=hf_your_huggingface_token_here

# ========================================
# EXTERNAL SERVICES (OPTIONAL)
# ========================================

# Langfuse telemetry (optional)
LANGFUSE_PUBLIC_KEY=
LANGFUSE_SECRET_KEY=

# Ngrok authtoken (optional - for external access)
NGROK_AUTHTOKEN=

# Neo4j credentials (optional)
NEO4J_PASSWORD=your-neo4j-password
28 changes: 28 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
*.wav
**/*.env
!**/.env.template
.env.secrets
.env.backup.*
config.env.backup.*
**/memory_config.yaml
!**/memory_config.yaml.template
example/*
Expand Down Expand Up @@ -71,6 +74,7 @@ backends/advanced-backend/data/speaker_model_cache/
backends/charts/advanced-backend/env-configmap.yaml

extras/openmemory-mcp/data/*
extras/openmemory/data/*
.env.backup.*

backends/advanced/nginx.conf
Expand All @@ -82,3 +86,27 @@ log.html
output.xml
report.html
.secrets
extras/openmemory-mcp/.env.openmemory
extras/openmemory/.env
certs

# Environment-specific configuration files (added 2025-12-09)
environments/
*.env.backup.*
backends/advanced/.env.*
!backends/advanced/.env.template

# SSL certificates
*.crt
*.key

# IDE and tool directories
.playwright-mcp/
.serena/

# Docker compose data directories
**/compose/data/

# Deprecated compose files (moved to root compose/)
backends/advanced/compose/infrastructure.yml
backends/advanced/compose/mycelia.yml
7 changes: 7 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[submodule "extras/mycelia"]
path = extras/mycelia
url = https://github.com/mycelia-tech/mycelia
[submodule "extras/openmemory"]
path = extras/openmemory
url = https://github.com/thestumonkey/mem0.git
branch = friend-lite-integration
82 changes: 0 additions & 82 deletions ACT_GUIDE.md

This file was deleted.

24 changes: 24 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,29 @@ Optional:
- **API Security**: JWT tokens required for all endpoints and WebSocket connections
- **Admin Bootstrap**: Automatic admin account creation with ADMIN_EMAIL/ADMIN_PASSWORD

## Quick Setup

Friend-Lite includes an interactive setup wizard that guides you through complete configuration:

```bash
make wizard
```

This single command will:
1. 🔐 Configure secrets (API keys, passwords)
2. 🌐 Optionally setup Tailscale for distributed deployment
3. 📦 Create a custom environment
4. 🚀 Provide clear instructions to start services

**Individual setup steps:**
```bash
make setup-secrets # Configure API keys and passwords
make setup-tailscale # Configure Tailscale and SSL (optional)
make setup-environment # Create environment config
```

For complete wizard documentation, see [`WIZARD.md`](WIZARD.md).

## Configuration

### Required Environment Variables
Expand Down Expand Up @@ -396,6 +419,7 @@ Project includes `.cursor/rules/always-plan-first.mdc` requiring understanding b
For detailed technical documentation, see:
- **[@docs/wyoming-protocol.md](docs/wyoming-protocol.md)**: WebSocket communication protocol details
- **[@docs/memory-providers.md](docs/memory-providers.md)**: In-depth memory provider comparison and setup
- **[@backends/advanced/Docs/mycelia-setup.md](backends/advanced/Docs/mycelia-setup.md)**: Complete Mycelia setup guide with auto-login and OAuth
- **[@docs/versioned-processing.md](docs/versioned-processing.md)**: Transcript and memory versioning details
- **[@docs/api-reference.md](docs/api-reference.md)**: Complete endpoint documentation with examples
- **[@docs/speaker-recognition.md](docs/speaker-recognition.md)**: Advanced analysis and live inference features
Expand Down
Loading
Loading