116 lines
3.5 KiB
Markdown
116 lines
3.5 KiB
Markdown
# Fluxer Branch Management Guide
|
|
|
|
## Current Setup
|
|
- **Branch**: `canary` (development/testing branch)
|
|
- **Repository**: https://git.vish.gg/Vish/homelab.git
|
|
- **Purpose**: Contains human verification fixes and custom configurations
|
|
|
|
## Why Canary Branch?
|
|
- `canary` is Fluxer's development branch - perfect for fixes and testing
|
|
- Keeps your modifications separate from stable releases
|
|
- Allows easy updates without breaking working configurations
|
|
- Industry standard for development/testing deployments
|
|
|
|
## Updating Your Branch
|
|
|
|
### 1. Update Your Custom Fixes
|
|
```bash
|
|
cd fluxer
|
|
git checkout canary
|
|
git pull origin canary
|
|
```
|
|
|
|
### 2. Get Upstream Fluxer Updates (Optional)
|
|
```bash
|
|
# Add upstream if not already added
|
|
git remote add upstream https://github.com/fluxerapp/fluxer.git
|
|
|
|
# Fetch and merge upstream changes
|
|
git fetch upstream
|
|
git merge upstream/canary
|
|
|
|
# Push merged changes back to your repo
|
|
git push origin canary
|
|
```
|
|
|
|
### 3. Update Just Your Fixes
|
|
```bash
|
|
# Make your changes to fix files
|
|
# Then commit and push
|
|
git add .
|
|
git commit -m "update: improve human verification fixes"
|
|
git push origin canary
|
|
```
|
|
|
|
## Branch Safety
|
|
|
|
### ✅ Safe Operations
|
|
- Working on `canary` branch
|
|
- Pulling from your own `origin/canary`
|
|
- Making fixes to verification/rate limiting
|
|
- Testing new configurations
|
|
|
|
### ⚠️ Be Careful With
|
|
- Merging upstream changes (test first)
|
|
- Major version updates from upstream
|
|
- Changing core database schemas
|
|
|
|
### 🚫 Avoid
|
|
- Working directly on `main` branch
|
|
- Force pushing (`git push --force`)
|
|
- Deleting the branch accidentally
|
|
|
|
## Quick Commands Reference
|
|
|
|
```bash
|
|
# Check current branch
|
|
git branch
|
|
|
|
# Switch to canary (if not already there)
|
|
git checkout canary
|
|
|
|
# See what's changed
|
|
git status
|
|
git log --oneline -10
|
|
|
|
# Update from your repo
|
|
git pull origin canary
|
|
|
|
# Update one-liner URLs after changes
|
|
# Complete setup: https://git.vish.gg/Vish/homelab/raw/branch/canary/fluxer/complete-setup.sh
|
|
# Quick fix: https://git.vish.gg/Vish/homelab/raw/branch/canary/fluxer/fix-human-verification.sh
|
|
```
|
|
|
|
## Deployment Strategy
|
|
|
|
1. **Development**: Work on `canary` branch (current setup)
|
|
2. **Testing**: Use the one-liner installers to test
|
|
3. **Production**: Deploy from `canary` when stable
|
|
4. **Rollback**: Keep previous working commits tagged
|
|
|
|
## 🎉 Branch Lifecycle Complete - Mission Accomplished!
|
|
|
|
### ✅ Canary Branch Successfully Merged and Removed
|
|
|
|
The `canary` branch has completed its mission and been safely removed:
|
|
|
|
1. **✅ Development Complete**: All human verification fixes developed and tested
|
|
2. **✅ Integration Complete**: Fixes moved to production structure in `homelab/deployments/fluxer-seattle/`
|
|
3. **✅ Production Ready**: One-liner installers created and tested
|
|
4. **✅ Cleanup Complete**: Canary branch merged and safely removed (February 2025)
|
|
|
|
### 🚀 Production URLs (Now Live)
|
|
- **Complete Setup**: `curl -sSL https://git.vish.gg/Vish/homelab/raw/branch/main/deployments/fluxer-seattle/complete-setup.sh | bash`
|
|
- **Quick Fix**: `curl -sSL https://git.vish.gg/Vish/homelab/raw/branch/main/deployments/fluxer-seattle/fix-human-verification.sh | bash`
|
|
|
|
### 🏗️ New Deployment Structure
|
|
All fixes are now permanently available in the main branch under:
|
|
```
|
|
homelab/deployments/fluxer-seattle/
|
|
├── complete-setup.sh # Full installation
|
|
├── fix-human-verification.sh # Fix existing installations
|
|
├── AuthRateLimitConfig.ts # Updated rate limits
|
|
└── README.md # Comprehensive documentation
|
|
```
|
|
|
|
**The human verification nightmare is officially over! 🌊** |