Environment Variables

AI/Chat Configuration

Priority order: Anthropic > Fanar > Ollama

Anthropic Claude (Optional)

# Anthropic Claude API for chat functionality
export ANTHROPIC_API_KEY="your-anthropic-api-key"
export ANTHROPIC_MODEL="claude-haiku-4-5-20250311"  # Default model

Fanar API (Optional)

# Fanar API for chat functionality
export FANAR_API_KEY="your-fanar-api-key"
export FANAR_API_URL="https://api.fanar.qa"  # Default: https://api.fanar.qa

Note: Fanar has a rate limit of 10 requests per minute, enforced automatically.

Ollama (Fallback)

# Used if neither Anthropic nor Fanar API key is set
export MODEL_NAME="llama3.2"                    # Default: llama3.2
export MODEL_API_URL="http://localhost:11434"   # Default: http://localhost:11434

YouTube Configuration

# YouTube API key for video functionality
export YOUTUBE_API_KEY="your-youtube-api-key"

Places Configuration

# Google Places API key for enhanced places search and nearby POI lookup
# Optional: falls back to OpenStreetMap/Overpass when not set
export GOOGLE_API_KEY="your-google-places-api-key"

Notes:

• When GOOGLE_API_KEY is set, Places uses the Google Places API (New) for search and nearby queries
• Without it, Places falls back to free OpenStreetMap/Overpass and Nominatim data
• Enable the Places API (New) in Google Cloud Console; the YouTube Data API key is separate

Vector Search Configuration

# Ollama endpoint for semantic vector search (embeddings)
export MODEL_API_URL="http://localhost:11434"   # Default: http://localhost:11434

Note: Vector search requires Ollama with nomic-embed-text model. If unavailable, falls back to keyword search. See Vector Search for installation.

TODO: The Ollama endpoint (http://localhost:11434) and embedding model (nomic-embed-text) are currently hardcoded in data/data.go. Consider making these configurable via MODEL_API_URL and a new EMBEDDING_MODEL environment variable.

ActivityPub Configuration

# Domain for ActivityPub federation (user discovery, actor URLs)
export MU_DOMAIN="yourdomain.com"  # Falls back to MAIL_DOMAIN, then "localhost"

Note: This must match your public domain so remote servers can resolve your users. See ActivityPub for details.

Messaging Configuration

Mu supports sending and receiving external email via SMTP.

# SMTP server port for receiving external email
export MAIL_PORT="2525"              # Default: 2525 (use 25 for production)

# Domain for email addresses
export MAIL_DOMAIN="yourdomain.com"  # Default: localhost

# DKIM signing selector
export MAIL_SELECTOR="default"       # Default: default

# DKIM private key (PEM format). Takes precedence over ~/.mu/keys/dkim.key
export DKIM_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n..."

Notes:

• SMTP configuration only needed for external email (sending/receiving outside Mu)
• Mu delivers external messages directly to recipient servers via SMTP (no relay needed)
• DKIM signing enables automatically when DKIM_PRIVATE_KEY is set, or if a key file exists at ~/.mu/keys/dkim.key
• DKIM_PRIVATE_KEY takes precedence over the key file (useful in Docker/cloud deployments)
• External email costs credits (SMTP delivery cost)

Stripe Configuration (Optional)

Enable card payments via Stripe for topping up credits.

# Stripe keys (optional - for card payments)
export STRIPE_SECRET_KEY="sk_live_..."
export STRIPE_PUBLISHABLE_KEY="pk_live_..."
export STRIPE_WEBHOOK_SECRET="whsec_..."  # For verifying Stripe webhook events

Notes:

• When empty, card payment option is hidden on the top-up page
• Configure a Stripe webhook pointing to /wallet/stripe/webhook to credit users after payment
• Supported events: checkout.session.completed

Payment Configuration (Optional)

Enable donations to support your instance. All variables are optional - leave empty for a free instance.

# One-time donation URL
export DONATION_URL="https://gocardless.com/your-donation-link"

Notes:

• When empty, donation features are hidden
• Links appear on /donate page

Quota Configuration

# Daily free AI queries (default: 10)
export FREE_DAILY_QUOTA="10"

# Credit costs per operation (default values shown)
export CREDIT_COST_NEWS="1"        # News search (1p)
export CREDIT_COST_VIDEO="2"       # Video search (2p) - YouTube API cost
export CREDIT_COST_VIDEO_WATCH="0" # Video watch (free) - no value added over YouTube
export CREDIT_COST_CHAT="3"        # Chat AI query (3p) - LLM cost
export CREDIT_COST_EMAIL="4"       # External email (4p) - SMTP delivery cost
export CREDIT_COST_PLACES_SEARCH="5"  # Places text search (5p) - Google Places API cost
export CREDIT_COST_PLACES_NEARBY="2"  # Nearby places lookup (2p) - Google Places API cost

Notes:

• 1 credit = £0.01 (1 penny)
• Admins get unlimited access (no quotas)
• Credits never expire

Example Usage

Development (Local Testing)

# Messaging server on port 2525
export MAIL_PORT="2525"
export MAIL_DOMAIN="localhost"

./mu --serve --address :8080

Production

# Messaging server on standard SMTP port 25
export MAIL_PORT="25"

# Your domain and DKIM configuration
export MAIL_DOMAIN="yourdomain.com"
export MAIL_SELECTOR="default"

./mu --serve --address :8080

All Environment Variables

.env File (Optional)

Create a .env file:

# AI/Chat (priority: Anthropic > Fanar > Ollama)
# ANTHROPIC_API_KEY=your-anthropic-api-key
FANAR_API_KEY=your-fanar-api-key
FANAR_API_URL=https://api.fanar.qa
MODEL_NAME=llama3.2
MODEL_API_URL=http://localhost:11434

# YouTube
YOUTUBE_API_KEY=your-youtube-api-key

# Places (optional - falls back to OpenStreetMap without this)
# GOOGLE_API_KEY=your-google-places-api-key

# Messaging (uses SMTP protocol)
MAIL_PORT=2525
MAIL_DOMAIN=yourdomain.com
MAIL_SELECTOR=default

# Stripe card payments (optional)
# STRIPE_SECRET_KEY=sk_live_...
# STRIPE_PUBLISHABLE_KEY=pk_live_...
# STRIPE_WEBHOOK_SECRET=whsec_...

# Donations (optional - leave empty for free instance)
DONATION_URL=https://gocardless.com/your-donation-link

Load and run:

export $(cat .env | xargs) && ./mu --serve --address :8080

Systemd Service Example

[Unit]
Description=Mu Service
After=network.target

[Service]
Type=simple
User=mu
WorkingDirectory=/opt/mu

# AI/Chat
Environment="FANAR_API_KEY=your-fanar-api-key"
Environment="FANAR_API_URL=https://api.fanar.ai"

# YouTube
Environment="YOUTUBE_API_KEY=your-youtube-api-key"

# Messaging
Environment="MAIL_PORT=25"
Environment="MAIL_DOMAIN=yourdomain.com"
Environment="MAIL_SELECTOR=default"
Environment="DKIM_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\n..."

# Donations (optional)
Environment="DONATION_URL=https://gocardless.com/your-donation-link"

ExecStart=/opt/mu/mu --serve --address :8080
Restart=always

[Install]
WantedBy=multi-user.target

Docker Example

FROM golang:1.24 AS builder
WORKDIR /app
COPY . .
RUN go build -o mu

FROM debian:bookworm-slim
COPY --from=builder /app/mu /usr/local/bin/
EXPOSE 8080 25
CMD ["mu", "--serve", "--address", ":8080"]

Run with environment variables:

docker run -d \
  -p 8080:8080 \
  -p 25:25 \
  -e FANAR_API_KEY=your-fanar-api-key \
  -e YOUTUBE_API_KEY=your-youtube-api-key \
  -e MAIL_PORT=25 \
  -e MAIL_DOMAIN=yourdomain.com \
  -e MAIL_SELECTOR=default \
  -e DONATION_URL=https://gocardless.com/your-donation-link \
  -v ~/.mu:/root/.mu \
  mu:latest

Getting API Keys

Anthropic API

• Sign up at Anthropic
• Get your API key from the Console
• Highest priority AI provider

Fanar API

• Sign up at Fanar AI
• Get your API key from the dashboard
• Used when Anthropic key is not set

YouTube API

1. Go to Google Cloud Console
2. Create a new project
3. Enable YouTube Data API v3
4. Create credentials (API Key)
5. Required for video search/playback

Google Places API

1. Go to Google Cloud Console
2. Create or reuse a project
3. Enable Places API (New)
4. Create credentials (API Key)
5. Optional — Places falls back to OpenStreetMap/Overpass without it

Feature Requirements