🚀 Deployment Guide Panel

1

Push Project to GitHub

📌 Goal: Initialize git, create main and dev branches, and push to GitHub

First, let's initialize your project with Git and create the necessary branches:

# Initialize git in your project folder
git init

# Add all your files
git add .

# Commit initial version
git commit -m "Initial commit"

# Create main branch
git branch -M main

# Add your GitHub repository (replace with your URL)
git remote add origin https://github.com/USERNAME/REPO.git

# Push main branch
git push -u origin main

# Create and push dev branch
git checkout -b dev
git push -u origin dev

✅ You now have both main and dev branches on GitHub!

💡 Git Cheatsheet

git branch List all branches
git checkout -b name Create and switch to new branch
git push origin branch Push branch to remote
git status Check current status
git log --oneline View commit history

2

Merge dev → main

📌 Goal: Merge your development branch into main for production

When your dev branch is ready for production, merge it into main:

# Switch to main branch
git checkout main

# Pull latest changes
git pull origin main

# Merge dev branch
git merge dev

# Push to GitHub
git push origin main

⚠️ Best Practice: Always test thoroughly in dev before merging to main

🔄 Merge Strategies

git merge --no-ff dev Force create merge commit
git merge --squash dev Combine all commits into one
git cherry-pick commit-id Apply specific commit

3

Connect to Server via SSH

📌 Goal: Establish secure connection to your server

Connect to your server using SSH with the provided credentials:

# Basic SSH connection
ssh -p PORT USER@SERVER_IP

# Example with specific port
ssh -p 2222 [email protected]

# With SSH key (recommended)
ssh -i ~/.ssh/mykey.pem -p 22 [email protected]

🔒 Security Tip: Use SSH keys instead of passwords for better security

🖥️ SSH Commands

exit Disconnect from server
whoami Check current user
pwd Show current directory
htop Monitor system resources
df -h Check disk usage

4

Clone Project on Server

📌 Goal: Set up your project on the server with dependencies

Clone your repository and set up the Python environment:

# Update system and install git
sudo apt update && sudo apt install git python3-pip python3-venv -y

# Clone your project
git clone https://github.com/USERNAME/REPO.git
cd REPO

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Create .env file for secrets
nano .env

📝 In the .env file, add your environment variables:

DATABASE_URL=postgresql://user:pass@localhost/db
API_KEY=your-secret-key
DEBUG=False

📦 Package Management

pip list Show installed packages
pip freeze > requirements.txt Save dependencies
deactivate Exit virtual environment
which python Check Python location

5

Test API with Uvicorn

📌 Goal: Run and test your FastAPI application

Start your FastAPI application with Uvicorn:

# Make sure venv is activated
source venv/bin/activate

# Run with auto-reload (development)
uvicorn main:app --reload --host 0.0.0.0 --port 8000

# Run in production mode
uvicorn main:app --host 0.0.0.0 --port 8000 --workers 4

🧪 Test your API: Open http://SERVER_IP:8000/docs in your browser

🚀 Uvicorn Options

--reload Auto-restart on code changes
--workers 4 Run with 4 worker processes
--log-level info Set logging level
--access-log Enable access logging

6

Create Systemd Service

📌 Goal: Set up auto-start service for your API

Create a systemd service to keep your API running:

# Create service file
sudo nano /etc/systemd/system/myapi.service

Add this configuration (adjust paths and user as needed):

[Unit]
Description=FastAPI Application
After=network.target

[Service]
Type=simple
User=ubuntu
Group=ubuntu
WorkingDirectory=/home/ubuntu/REPO
Environment="PATH=/home/ubuntu/REPO/venv/bin"
ExecStart=/home/ubuntu/REPO/venv/bin/uvicorn main:app --host 0.0.0.0 --port 8000
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Enable and start the service:

# Reload systemd
sudo systemctl daemon-reload

# Enable auto-start
sudo systemctl enable myapi

# Start the service
sudo systemctl start myapi

# Check status
sudo systemctl status myapi

🛠️ Service Management

sudo systemctl restart myapi Restart service
sudo systemctl stop myapi Stop service
sudo journalctl -u myapi -f View live logs
sudo journalctl -u myapi -n 100 Last 100 log lines

7

Setup Domain with Caddy

📌 Goal: Configure HTTPS with Caddy reverse proxy

Configure your domain in Caddy panel (caddy.oanor.com):

📝 Add new site → ID: your-service-name
🔌 Set Port: 8000 (your API port)
🌐 Enter your domain: api.example.com
🔒 Enable Cloudflare certificate
💾 Save and deploy configuration

⚠️ DNS Setup: Make sure your domain points to your server IP in Cloudflare

Alternative: Manual Caddyfile configuration:

api.example.com {
    reverse_proxy localhost:8000
    
    # Optional: Custom headers
    header {
        X-Content-Type-Options nosniff
        X-Frame-Options DENY
        X-XSS-Protection "1; mode=block"
    }
    
    # Enable compression
    encode gzip
}

🌐 DNS & SSL Tips

A Record Point domain to server IP
CNAME Alias to another domain
Enable Cloudflare proxy for DDoS protection
SSL/TLS mode: Full (strict) recommended

8

Final Testing

📌 Goal: Verify your deployment is working correctly

Test your live API with HTTPS:

# Test with curl
curl -I https://api.example.com

# Check API docs
curl https://api.example.com/docs

# Test specific endpoint
curl https://api.example.com/health

# Check SSL certificate
openssl s_client -connect api.example.com:443 -servername api.example.com

🎉 Success! Your API should be live at:

📖 Docs: https://api.example.com/docs
🔧 Redoc: https://api.example.com/redoc
💻 API: https://api.example.com/

🔍 Troubleshooting

502 Bad Gateway → Check if service is running
Connection refused → Check firewall/ports
SSL errors → Verify DNS and Cloudflare settings
Check logs: sudo journalctl -u myapi -f

🚀 Deployment Complete!

Your application is now live and secured with HTTPS. Monitor logs and set up backups for production use.