Skip to content

ENV_SETUP_README.md

Latest commit

 

History

History
134 lines (102 loc) · 3.29 KB

ENV_SETUP_README.md

File metadata and controls

134 lines (102 loc) · 3.29 KB

Environment Variable Setup - Quick Start

This guide provides quick setup instructions for environment variables in the YieldVault project.

🚀 Quick Setup

For Local Development

# 1. Backend setup
cd backend
cp .env.local.example .env.local
# Edit .env.local with your values
nano .env.local

# 2. Frontend setup
cd ../frontend
cp .env.local.example .env.local
# Edit .env.local with your values
nano .env.local

# 3. Verify setup
cd ..
./scripts/verify-env-security.sh

For Production Deployment

# 1. Backend setup
cd backend
cp .env.production.example .env.production
# Edit .env.production with production values
nano .env.production

# 2. Frontend setup
cd ../frontend
cp .env.production.example .env.production
# Edit .env.production with production values
nano .env.production

# 3. Verify setup
cd ..
./scripts/verify-env-security.sh

📋 Required Variables

Backend (Minimum Required)

STELLAR_RPC_URL=https://soroban-testnet.stellar.org
STELLAR_NETWORK_PASSPHRASE=Test SDF Network ; September 2015
VAULT_CONTRACT_ID=your-contract-id-here

Frontend (Minimum Required)

VITE_SOROBAN_RPC_URL=https://soroban-testnet.stellar.org
VITE_STELLAR_NETWORK_PASSPHRASE=Test SDF Network ; September 2015
VITE_VAULT_CONTRACT_ID=your-contract-id-here

🔒 Security Rules

  1. NEVER commit .env files (except .env.example)
  2. Use different secrets for each environment
  3. Rotate secrets regularly (see schedule in SECURITY_ENV_CHECKLIST.md)
  4. Verify before deploying using ./scripts/verify-env-security.sh

📚 Documentation

🛠️ Troubleshooting

"Contract ID not configured"

# Make sure you've set the contract ID in your .env file
echo "VAULT_CONTRACT_ID=your-id" >> backend/.env.local
echo "VITE_VAULT_CONTRACT_ID=your-id" >> frontend/.env.local

"Wrong network" error

# Ensure RPC URL and passphrase match
# For testnet:
STELLAR_RPC_URL=https://soroban-testnet.stellar.org
STELLAR_NETWORK_PASSPHRASE=Test SDF Network ; September 2015

# For mainnet:
STELLAR_RPC_URL=https://soroban-mainnet.stellar.org
STELLAR_NETWORK_PASSPHRASE=Public Global Stellar Network ; September 2015

CORS errors

# Add your frontend URL to backend CORS
echo "CORS_ALLOWED_ORIGINS=http://localhost:5173" >> backend/.env.local

✅ Verification

Run the security verification script:

./scripts/verify-env-security.sh

This checks:

  • ✓ .env files are gitignored
  • ✓ No secrets committed to git
  • ✓ No hardcoded secrets in code
  • ✓ Proper file structure
  • ✓ No secrets in git history

🆘 Support

If you need help:

  1. Check the ENVIRONMENT_SETUP_GUIDE.md
  2. Review example files (.env.*.example)
  3. Contact the DevOps team
  4. Check the troubleshooting section above

Quick Links: