Cursor rule

1---
2description: Environment variables and configuration setup
3globs: [".env*", "src/config/**/*.py"]
4alwaysApply: false
5---
6 
7# Environment Setup
8 
9## Required Environment Variables
10 
11```bash
12# Required
13UNIFI_API_KEY=your-api-key-here
14UNIFI_API_TYPE=cloud  # or "local"
15UNIFI_HOST=api.ui.com  # or local gateway IP
16UNIFI_SITE=default
17 
18# Optional
19REDIS_HOST=localhost  # Enable caching
20REDIS_PORT=6379
21WEBHOOK_SECRET=your-secret  # Enable webhook HMAC verification
22```
23 
24## Configuration Loading Order
25 
26The server merges settings from **environment variables**, an optional `.env` file, and `src/config/config.py` (listed in order of precedence).
27 
28## API Configuration
29 
30### Cloud API (Default)
31 
32```bash
33UNIFI_API_TYPE=cloud
34UNIFI_CLOUD_API_URL=https://api.ui.com
35```
36 
37### Local Gateway Proxy
38 
39```bash
40UNIFI_API_TYPE=local
41UNIFI_LOCAL_HOST=192.168.2.1
42UNIFI_LOCAL_PORT=443
43UNIFI_LOCAL_VERIFY_SSL=true
44```
45 
46## Development Environment
47 
48Always use `.env.example` as a template:
49 
50```bash
51# Copy example file
52cp .env.example .env
53 
54# Never commit .env to version control
55# It's in .gitignore by default
56```
57 
58## Configuration in Code
59 
60Load settings in Python using Pydantic:
61 
62```python
63from src.config.config import Settings
64 
65settings = Settings()  # Automatically loads from environment
66```
67 
68## Security Reminders
69 
70- **NEVER** hardcode API keys in source code
71- **NEVER** commit `.env` files to version control
72- **ALWAYS** use environment variables for sensitive data
73- **ALWAYS** mask sensitive data in logs
74- **ALWAYS** validate configuration on startup
75