Skip to content

Commit 7b207bf

Browse files
committed
Create comprehensive root-level .env.template file
- Add all required environment variables for Docker Compose setup - Include clear comments explaining each variable and its purpose - Organize variables into logical sections (Registry, Auth, Security, Cognito, etc.) - Provide setup instructions and references to documentation - Include generation instructions for SECRET_KEY - Add optional variables like GitHub OAuth and API keys - Reference docs/cognito.md for detailed Cognito setup - Compatible with build_and_run.sh script - Addresses issue #17
1 parent b0f079a commit 7b207bf

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

.env.template

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# =============================================================================
2+
# MCP Gateway Registry - Environment Configuration Template
3+
# =============================================================================
4+
# Copy this file to .env and fill in your actual values
5+
# The build_and_run.sh script will automatically generate a SECRET_KEY if not provided
6+
7+
# =============================================================================
8+
# REGISTRY CONFIGURATION
9+
# =============================================================================
10+
# Registry URL - typically http://localhost:7860 for local development
11+
REGISTRY_URL=http://localhost:7860
12+
13+
# Admin credentials for the web UI and API access
14+
# Change these to secure values for production
15+
ADMIN_USER=admin
16+
ADMIN_PASSWORD=your-secure-password-here
17+
18+
# =============================================================================
19+
# AUTH SERVER CONFIGURATION
20+
# =============================================================================
21+
# Internal auth server URL (used by containers to communicate)
22+
AUTH_SERVER_URL=http://auth-server:8888
23+
24+
# External auth server URL (used by clients outside the container network)
25+
# For local development: http://localhost:8888
26+
# For production: https://your-domain.com or http://your-ec2-instance.amazonaws.com
27+
AUTH_SERVER_EXTERNAL_URL=http://localhost:8888
28+
29+
# =============================================================================
30+
# SECURITY CONFIGURATION
31+
# =============================================================================
32+
# Secret key for session cookie signing and other cryptographic operations
33+
# Will be auto-generated by build_and_run.sh if not provided
34+
# To generate manually: python -c 'import secrets; print(secrets.token_hex(32))'
35+
SECRET_KEY=
36+
37+
# =============================================================================
38+
# AWS COGNITO OAUTH2 CONFIGURATION
39+
# =============================================================================
40+
# AWS region where your Cognito User Pool is located
41+
AWS_REGION=us-east-1
42+
43+
# Cognito User Pool ID - found in AWS Console under Cognito User Pools
44+
# Format: us-east-1_XXXXXXXXX
45+
COGNITO_USER_POOL_ID=your-cognito-user-pool-id-here
46+
47+
# Cognito App Client ID - found in your User Pool's App Clients section
48+
COGNITO_CLIENT_ID=your-cognito-client-id-here
49+
50+
# Cognito App Client Secret - found in your User Pool's App Clients section
51+
# Note: Only required if your app client has a secret configured
52+
COGNITO_CLIENT_SECRET=your-cognito-client-secret-here
53+
54+
# =============================================================================
55+
# GITHUB OAUTH CONFIGURATION (Optional)
56+
# =============================================================================
57+
# GitHub OAuth App credentials - only needed if using GitHub authentication
58+
# Leave empty if only using Cognito authentication
59+
GITHUB_CLIENT_ID=
60+
GITHUB_CLIENT_SECRET=
61+
62+
# =============================================================================
63+
# EXTERNAL API KEYS
64+
# =============================================================================
65+
# Polygon.io API key for financial data MCP server
66+
# Get your free API key from: https://polygon.io/dashboard/signup
67+
# The fininfo MCP server will still start without this but will return 401 errors
68+
POLYGON_API_KEY=your-polygon-api-key-here
69+
70+
# =============================================================================
71+
# SETUP INSTRUCTIONS
72+
# =============================================================================
73+
# 1. Copy this file: cp .env.template .env
74+
# 2. Fill in the required values above
75+
# 3. For Cognito setup, see: docs/cognito.md
76+
# 4. Run: ./build_and_run.sh
77+
# 5. Access the registry at: http://localhost:7860 (or your configured URL)
78+
#
79+
# Required for basic functionality:
80+
# - ADMIN_PASSWORD (set to a secure value)
81+
# - COGNITO_USER_POOL_ID, COGNITO_CLIENT_ID, COGNITO_CLIENT_SECRET
82+
#
83+
# Optional but recommended:
84+
# - POLYGON_API_KEY (for financial data tools)
85+
# - AUTH_SERVER_EXTERNAL_URL (for external client access)

0 commit comments

Comments
 (0)