foxcloud

FoxCloud Deployment Guide

This guide covers all available methods for deploying FoxCloud to Cloudflare Workers.

Prerequisites

Before deploying, ensure you have:

  1. A Cloudflare account
  2. A domain configured in Cloudflare
  3. Wrangler CLI installed: npm install -g wrangler
  4. Node.js 18 or higher
  1. Download the latest worker.js from Releases
  2. Install Wrangler globally: 
    npm install -g wrangler
  3. Deploy to Cloudflare Workers: 
    wrangler deploy worker.js
  4. Configure environment variables as described in Environment Variables Guide
  1. Clone the repository: 
    git clone https://github.com/code3-dev/foxcloud.git
cd foxcloud
  2. Install dependencies: 
    npm install
  3. Build the project: 
    npm run build
  4. Deploy to Cloudflare Workers: 
    npm run deploy
  5. Configure environment variables as described in Environment Variables Guide
  1. Fork the repository
  2. Set up Cloudflare credentials in repository secrets:
    • CLOUDFLARE_API_TOKEN: Your Cloudflare API token
    • CLOUDFLARE_ACCOUNT_ID: Your Cloudflare account ID
  3. Enable GitHub Actions in repository settings
  4. Push to master branch to trigger automatic deployment
  5. Configure environment variables in the Cloudflare Dashboard

Setting Up Cloudflare Credentials

  1. Create a Cloudflare API token:
    • Go to Cloudflare Dashboard → My Profile → API Tokens
    • Create a token with Workers Scripts: Edit permission
  2. Get your Account ID:
    • Go to Cloudflare Dashboard → Workers & Pages
    • Your Account ID is displayed in the sidebar
  3. Add secrets to GitHub:
    • Go to your forked repository → Settings → Secrets and variables → Actions
    • Add CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID as repository secrets

Configuration After Deployment

After deploying, you need to configure environment variables:

  1. Go to Cloudflare Dashboard → Workers & Pages
  2. Select your deployed Worker
  3. Go to Settings → Variables
  4. Add the following variables:
    • UUID: Your user UUID(s)
    • PROXY_IP: Your proxy server IP(s)

Custom Domain Setup

To use a custom domain:

  1. In the Cloudflare Dashboard, go to your Worker
  2. Navigate to “Settings” → “Triggers”
  3. Under “Custom Domains”, add your domain
  4. Ensure your domain is configured in Cloudflare DNS

Troubleshooting Deployment

Common Issues

  1. Authentication errors: Verify your Cloudflare API token has the correct permissions
  2. Build failures: Ensure all dependencies are installed with npm install
  3. Deployment timeouts: Check your internet connection and try again
  4. Environment variables not found: Verify variables are set in the Cloudflare Dashboard

Checking Deployment Status

  1. View deployment logs in GitHub Actions (for CI/CD deployments)
  2. Check Cloudflare Dashboard for deployment status
  3. Test your deployment by visiting your Worker URL

Updating Your Deployment

For Pre-built Worker

  1. Download the new worker.js from Releases
  2. Redeploy using wrangler deploy worker.js

For Source Builds

  1. Pull the latest changes: git pull
  2. Rebuild: npm run build
  3. Redeploy: npm run deploy

For GitHub Actions

  1. Pull the latest changes or merge upstream changes
  2. Push to your repository to trigger automatic deployment

Rollback Procedure

If you need to rollback to a previous version:

  1. Identify the previous working version
  2. Either:
    • Download the previous release’s worker.js and redeploy
    • Revert your repository to the previous commit and redeploy
    • Use Cloudflare’s rollback feature in the dashboard

Monitoring and Logs

Monitor your Worker performance through:

  1. Cloudflare Dashboard → Workers & Pages → Your Worker → Analytics
  2. Real-time logs with wrangler tail
  3. Custom logging in your application code

For any deployment issues not covered in this guide, please check the Issues section of the repository or create a new issue.

This site is open source. Improve this page.