Files
blackroad-private-enhancements/docs/QUICK_START.md
blackboxprogramming 4acdf1f8ac
Some checks failed
☁️ Cloudflare Deployment / Deploy Workers (push) Has been cancelled
🚂 Railway Deployment / Deploy to Railway (push) Has been cancelled
🌐 Unified Multi-Platform Deployment / 🔍 Prepare (push) Has been cancelled
▲ Vercel Deployment / Deploy to Vercel (push) Has been cancelled
🌐 Unified Multi-Platform Deployment / 🚀 Deploy all platforms (push) Has been cancelled
🔒 Security Scanning / 📦 Dependencies (push) Failing after 40s
🔒 Security Scanning / 🔐 Secrets (push) Failing after 1m34s
💾 Automated Backup / 📦 Backup infrastructure (push) Failing after 45s
🏥 Infrastructure Health Monitoring / 🔍 Health Check (push) Successful in 2s
Initial commit — RoadCode import
2026-03-08 20:04:29 -05:00

199 lines
5.2 KiB
Markdown

# ⚡ BlackRoad-Private Infrastructure - Quick Start
**5-minute setup for multi-platform deployment**
## 🚀 Deploy in 3 Steps
### Step 1: Copy Files (1 minute)
```bash
# Navigate to BlackRoad-Private repository
cd ~/BlackRoad-Private # or wherever you cloned it
# Copy all configuration files
cp ~/blackroad-private-enhancements/*.json ./
cp ~/blackroad-private-enhancements/*.toml ./
# Copy workflows
cp ~/blackroad-private-enhancements/.github/workflows/* ./.github/workflows/
# Copy documentation
mkdir -p docs
cp ~/blackroad-private-enhancements/docs/* ./docs/
cp ~/blackroad-private-enhancements/README.md ./INFRASTRUCTURE.md
```
### Step 2: Add Secrets (2 minutes)
Go to: https://github.com/BlackRoad-OS/BlackRoad-Private/settings/secrets/actions
Click **New repository secret** for each:
#### Railway (3 secrets)
- Name: `RAILWAY_TOKEN` → Value: Get from https://railway.app/account/tokens
- Name: `RAILWAY_PROJECT_ID` → Value: From Railway project settings
- Name: `RAILWAY_HEALTH_URL` → Value: `https://blackroad-private.up.railway.app/api/health`
#### Cloudflare (4 secrets)
- Name: `CLOUDFLARE_API_TOKEN` → Value: Create at https://dash.cloudflare.com/profile/api-tokens
- Name: `CLOUDFLARE_ACCOUNT_ID` → Value: From Cloudflare dashboard URL
- Name: `CLOUDFLARE_ZONE_ID` → Value: From domain overview
- Name: `CLOUDFLARE_HEALTH_URL` → Value: `https://private.blackroad.systems/api/health`
#### Vercel (4 secrets)
- Name: `VERCEL_TOKEN` → Value: Generate at https://vercel.com/account/tokens
- Name: `VERCEL_ORG_ID` → Value: From team settings
- Name: `VERCEL_PROJECT_ID` → Value: From project settings
- Name: `VERCEL_HEALTH_URL` → Value: `https://blackroad-private.vercel.app/api/health`
### Step 3: Deploy (2 minutes)
```bash
# Create feature branch
git checkout -b feature/multi-platform-infrastructure
# Commit everything
git add .
git commit -m "feat: Add multi-platform deployment infrastructure"
# Push
git push origin feature/multi-platform-infrastructure
# Create PR
gh pr create --title "Add Multi-Platform Deployment" \
--body "Railway + Cloudflare + Vercel deployment automation"
# Merge PR (triggers deployments)
gh pr merge --squash
```
## ✅ Verify It Works
### Check Workflows (30 seconds)
1. Go to: https://github.com/BlackRoad-OS/BlackRoad-Private/actions
2. You should see 7 new workflows
3. Click any workflow to see it run
### Check Deployments (1 minute)
```bash
# Test Railway
curl https://blackroad-private.up.railway.app/api/health
# Test Cloudflare
curl https://private.blackroad.systems/api/health
# Test Vercel
curl https://blackroad-private.vercel.app/api/health
```
Expected response:
```json
{
"status": "healthy",
"service": "blackroad-private",
"timestamp": "2026-02-14T08:35:00Z"
}
```
## 🎯 What You Get
**Automatic deployments** - Push to main → Deploys everywhere
**Preview deployments** - Every PR gets a Vercel preview
**Health monitoring** - 15-minute checks, auto-alerts
**Security scans** - Weekly dependency & secrets scans
**Daily backups** - Configurations backed up daily
**Multi-platform** - Railway + Cloudflare + Vercel ready
## 📊 First Deployment
After merging PR, watch the magic happen:
1. **railway-deploy.yml** - Deploys backend to Railway
2. **cloudflare-deploy.yml** - Deploys Workers to Cloudflare
3. **vercel-deploy.yml** - Deploys to Vercel
4. **unified-deploy.yml** - Orchestrates everything
Check progress: https://github.com/BlackRoad-OS/BlackRoad-Private/actions
## 🔥 Pro Tips
### Trigger Manual Deploy
```bash
# Go to Actions → Select workflow → "Run workflow" button
# OR use gh CLI:
gh workflow run "Unified Multi-Platform Deployment" -f platforms=railway,cloudflare,vercel
```
### Test Locally Before Deploy
```bash
# Railway
railway login
railway link
railway up
# Cloudflare
wrangler login
wrangler deploy
# Vercel
vercel login
vercel --prod
```
### Monitor Health
```bash
# Check all platforms
for url in \
"https://blackroad-private.up.railway.app/api/health" \
"https://private.blackroad.systems/api/health" \
"https://blackroad-private.vercel.app/api/health"; do
echo "Testing: $url"
curl -s "$url" | jq
done
```
## 🆘 Quick Fixes
### Workflow not showing up?
```bash
# Check file locations
ls -la .github/workflows/
# Should show 7 .yml files
```
### Deployment failed?
1. Check Actions tab for error message
2. Verify secrets are set correctly
3. See `docs/TROUBLESHOOTING.md`
### Health check failed?
```bash
# Test manually
curl -v https://your-service/api/health
```
## 📚 Next Steps
- [ ] Read `INFRASTRUCTURE.md` for architecture details
- [ ] Review `docs/DEPLOYMENT.md` for advanced deployment options
- [ ] Check `docs/TROUBLESHOOTING.md` for common issues
- [ ] Set up notification preferences in GitHub
- [ ] Customize health check URLs if needed
## 🎉 You're Done!
Your BlackRoad-Private infrastructure now has:
- ✅ Multi-platform deployment automation
- ✅ Health monitoring every 15 minutes
- ✅ Security scanning
- ✅ Daily backups
- ✅ Comprehensive documentation
**Time to deploy:** ~5 minutes
**Maintenance required:** ~10 minutes/week
**Reliability:** Enterprise-grade
---
**Need help?** Check `docs/TROUBLESHOOTING.md` or create an issue!