feat(env): added more optional env var examples

[waleedlatif1]

Summary

• added more optional env var examples

Type of Change

• New feature

Testing

Tested manually

Checklist

• Code follows project style guidelines
• Self-reviewed my changes
• Tests added/updated and passing
• No new warnings introduced
• I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Preview	Comments	Updated (UTC)
docs	Skipped			Nov 30, 2025 5:13pm

[greptile-apps]

Greptile Overview

Greptile Summary

Added API_ENCRYPTION_KEY environment variable example to the .env.example file in the Security section.

• The variable is correctly documented with usage instructions (openssl rand -hex 32) and purpose (encrypting API keys)
• The implementation is already present in the codebase (apps/sim/lib/api-key/crypto.ts and apps/sim/lib/env.ts)
• The variable is properly marked as optional in the schema validation
• Placement in the Security section is appropriate and follows existing patterns

Confidence Score: 5/5

• This PR is safe to merge with no risk
• This is a documentation-only change that adds an example for an optional environment variable that is already implemented and validated in the codebase. The variable is properly documented with generation instructions and usage context. No code logic is affected.
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
apps/sim/.env.example	5/5	Added API_ENCRYPTION_KEY example to security section for encrypting API keys

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Env as .env.example
    participant EnvFile as .env File
    participant EnvSchema as lib/env.ts
    participant Crypto as lib/api-key/crypto.ts
    participant DB as Database

    Dev->>Env: Review environment variable examples
    Note over Env: API_ENCRYPTION_KEY example<br/>with generation instructions
    Dev->>EnvFile: Create/update local env file
    Dev->>EnvFile: Add generated encryption key
    
    Note over EnvSchema: Validate API_ENCRYPTION_KEY<br/>(optional, min 32 chars)
    EnvSchema->>EnvFile: Load and validate environment
    
    alt Encryption key is configured
        Crypto->>EnvSchema: Read encryption key
        Crypto->>Crypto: Encrypt API keys using AES-256-GCM
        Crypto->>DB: Store encrypted API keys
    else Encryption key not configured
        Note over Crypto: Log warning about plain text storage
        Crypto->>DB: Store plain text API keys
    end

Loading

[greptile-apps]

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}