Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
Self Hosting using Coolify (#1880)
Moulik Aggarwal8e23e9941c08
diff --git a/.github/workflows/docker-publish-dev.yml b/.github/workflows/docker-publish-dev.ymlnew file mode 100644index 000000000..0395afaa4--- /dev/null+++ b/.github/workflows/docker-publish-dev.yml@@ -0,0 +1,128 @@+name: Publish Docker Images (Development)++on:+ workflow_dispatch:++env:+ REGISTRY: ghcr.io+ IMAGE_NAME: openstatus++jobs:+ build-and-push-dev:+ runs-on: ubuntu-latest+ permissions:+ contents: read+ id-token: write+ packages: write++ strategy:+ matrix:+ service: [server, dashboard, workflows, private-location, status-page, checker]+ include:+ - service: server+ context: .+ dockerfile: apps/server/Dockerfile+ port: 3001+ - service: dashboard+ context: .+ dockerfile: apps/dashboard/Dockerfile+ port: 3002+ - service: workflows+ context: .+ dockerfile: apps/workflows/Dockerfile+ port: 3000+ - service: private-location+ context: apps/private-location+ dockerfile: apps/private-location/Dockerfile+ port: 8081+ - service: status-page+ context: .+ dockerfile: apps/status-page/Dockerfile+ port: 3003+ - service: checker+ context: apps/checker+ dockerfile: apps/checker/Dockerfile+ port: 8082++ steps:+ - name: Checkout repository+ uses: actions/checkout@v4++ - name: Set up Docker Buildx+ uses: docker/setup-buildx-action@v3++ - name: Log in to Container Registry+ uses: docker/login-action@v3+ with:+ registry: ${{ env.REGISTRY }}+ username: ${{ github.repository_owner }}+ password: ${{ secrets.GITHUB_TOKEN }}++ - name: Extract metadata+ id: meta+ uses: docker/metadata-action@v5+ with:+ images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}-${{ matrix.service }}+ tags: |+ type=ref,event=branch,suffix=-${{ matrix.service }}+ type=ref,event=pr,suffix=-${{ matrix.service }}+ type=sha,prefix=dev-,suffix=-${{ matrix.service }}+ type=raw,value=dev-latest,suffix=-${{ matrix.service }}++ - name: Build and push Docker image+ uses: docker/build-push-action@v5+ with:+ context: ${{ matrix.context }}+ file: ${{ matrix.dockerfile }}+ push: true+ tags: ${{ steps.meta.outputs.tags }}+ labels: ${{ steps.meta.outputs.labels }}+ platforms: linux/amd64+ cache-from: type=gha+ cache-to: type=gha,mode=max+ provenance: false++ test-images:+ runs-on: ubuntu-latest+ needs: build-and-push-dev+ if: github.event_name == 'pull_request'++ steps:+ - name: Checkout repository+ uses: actions/checkout@v4++ - name: Set up Docker Compose+ run: |+ sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose+ sudo chmod +x /usr/local/bin/docker-compose++ - name: Create test compose file+ run: |+ cp docker-compose.github-packages.yaml docker-compose.test.yaml+ # Replace latest tags with dev-latest for testing+ sed -i 's/:latest/:dev-latest/g' docker-compose.test.yaml++ - name: Test service startup+ run: |+ # Start external services first+ docker-compose -f docker-compose.test.yaml up -d libsql tinybird-local++ # Wait for external services to be healthy+ timeout 120 bash -c 'until docker-compose -f docker-compose.test.yaml ps libsql | grep -q "healthy"; do sleep 5; done'+ timeout 120 bash -c 'until docker-compose -f docker-compose.test.yaml ps tinybird-local | grep -q "healthy"; do sleep 5; done'++ # Start one service for basic testing+ docker-compose -f docker-compose.test.yaml up -d workflows++ # Wait and check if it's running+ sleep 30+ if ! docker-compose -f docker-compose.test.yaml ps workflows | grep -q "Up"; then+ echo "Workflows service failed to start"+ docker-compose -f docker-compose.test.yaml logs workflows+ exit 1+ fi++ - name: Cleanup+ if: always()+ run: |+ docker-compose -f docker-compose.test.yaml down -vdiff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.ymlnew file mode 100644index 000000000..8ffb92df6--- /dev/null+++ b/.github/workflows/docker-publish.yml@@ -0,0 +1,116 @@+name: Publish Docker Images++on:+ push:+ branches:+ - main+ paths:+ - "apps/server/**"+ - "apps/dashboard/**"+ - "apps/workflows/**"+ - "apps/private-location/**"+ - "apps/status-page/**"+ - "apps/checker/**"+ - "packages/**"+ - "docker-compose.yaml"+ workflow_dispatch:+ inputs:+ services:+ description: 'Services to build (comma-separated)'+ required: false+ default: 'server,dashboard,workflows,private-location,status-page,checker'+ type: string++env:+ REGISTRY: ghcr.io+ IMAGE_NAME: openstatus++jobs:+ build-and-push:+ runs-on: ubuntu-latest+ permissions:+ contents: read+ id-token: write+ packages: write++ strategy:+ matrix:+ service: [server, dashboard, workflows, private-location, status-page, checker]+ include:+ - service: server+ context: .+ dockerfile: apps/server/Dockerfile+ port: 3001+ - service: dashboard+ context: .+ dockerfile: apps/dashboard/Dockerfile+ port: 3002+ - service: workflows+ context: .+ dockerfile: apps/workflows/Dockerfile+ port: 3000+ - service: private-location+ context: apps/private-location+ dockerfile: apps/private-location/Dockerfile+ port: 8081+ - service: status-page+ context: .+ dockerfile: apps/status-page/Dockerfile+ port: 3003+ - service: checker+ context: apps/checker+ dockerfile: apps/checker/Dockerfile+ port: 8082++ steps:+ - name: Checkout repository+ uses: actions/checkout@v4++ - name: Set up Docker Buildx+ uses: docker/setup-buildx-action@v3++ - name: Log in to Container Registry+ uses: docker/login-action@v3+ with:+ registry: ${{ env.REGISTRY }}+ username: ${{ github.repository_owner }}+ password: ${{ secrets.GITHUB_TOKEN }}++ - name: Extract metadata+ id: meta+ uses: docker/metadata-action@v5+ with:+ images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}-${{ matrix.service }}+ tags: |+ type=ref,event=branch,suffix=-${{ matrix.service }}+ type=ref,event=pr,suffix=-${{ matrix.service }}+ type=sha,prefix={{branch}}-,suffix=-${{ matrix.service }}+ type=raw,value=latest,enable={{is_default_branch}},suffix=-${{ matrix.service }}++ - name: Build and push Docker image+ id: build+ uses: docker/build-push-action@v5+ with:+ context: ${{ matrix.context }}+ file: ${{ matrix.dockerfile }}+ push: true+ tags: ${{ steps.meta.outputs.tags }}+ labels: ${{ steps.meta.outputs.labels }}+ platforms: linux/amd64,linux/arm64+ cache-from: type=gha+ cache-to: type=gha,mode=max+ provenance: false++ - name: Generate SBOM+ uses: anchore/sbom-action@v0+ with:+ image: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}-${{ matrix.service }}@${{ steps.build.outputs.digest }}+ format: spdx-json+ output-file: sbom-${{ matrix.service }}.spdx.json++ - name: Upload SBOM+ uses: actions/upload-artifact@v4+ with:+ name: sbom-${{ matrix.service }}+ path: sbom-${{ matrix.service }}.spdx.json+ retention-days: 30diff --git a/COOLIFY_DEPLOYMENT.md b/COOLIFY_DEPLOYMENT.mdnew file mode 100644index 000000000..39119168a--- /dev/null+++ b/COOLIFY_DEPLOYMENT.md@@ -0,0 +1,180 @@+# Coolify Deployment Guide++This guide explains how to deploy OpenStatus using Coolify with pre-built Docker images from GitHub Container Registry.++## Prerequisites++- Coolify instance (self-hosted or cloud)+- GitHub account with access to the repository+- Environment variables configured++## Available Docker Images++All images are published to `ghcr.io/openstatusHQ/openstatus-*`:++- `ghcr.io/openstatusHQ/openstatus-server:latest` - Main API server+- `ghcr.io/openstatusHQ/openstatus-dashboard:latest` - Web dashboard+- `ghcr.io/openstatusHQ/openstatus-workflows:latest` - Workflow engine+- `ghcr.io/openstatusHQ/openstatus-private-location:latest` - Private monitoring agent+- `ghcr.io/openstatusHQ/openstatus-status-page:latest` - Public status page+- `ghcr.io/openstatusHQ/openstatus-checker:latest` - Monitoring checker service++## Coolify Setup++### 1. Create a New Application++1. In Coolify, click "Add New" β "Application"+2. Choose "Docker" as the application type+3. Select "Public Repository" for the image source++### 2. Configure Each Service++#### Server Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-server:latest`+- **Port**: 3000+- **Environment Variables**:+ ```yaml+ DATABASE_URL: http://libsql:8080+ PORT: 3000+ # Add other required variables from .env.docker+ ```++#### Dashboard Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-dashboard:latest`+- **Port**: 3000+- **Environment Variables**:+ ```yaml+ DATABASE_URL: http://libsql:8080+ PORT: 3000+ HOSTNAME: 0.0.0.0+ AUTH_TRUST_HOST: true+ ```++#### Workflows Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-workflows:latest`+- **Port**: 3000+- **Environment Variables**:+ ```yaml+ DATABASE_URL: http://libsql:8080+ PORT: 3000+ ```++#### Private Location Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-private-location:latest`+- **Port**: 8080+- **Environment Variables**:+ ```yaml+ DB_URL: http://libsql:8080+ TINYBIRD_URL: http://tinybird-local:7181+ GIN_MODE: release+ PORT: 8080+ ```++#### Checker Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-checker:latest`+- **Port**: 8080+- **Environment Variables**:+ ```yaml+ DATABASE_URL: http://libsql:8080+ PORT: 8080+ ```++#### Status Page Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-status-page:latest`+- **Port**: 3000+- **Environment Variables**:+ ```yaml+ DATABASE_URL: http://libsql:8080+ PORT: 3000+ HOSTNAME: 0.0.0.0+ AUTH_TRUST_HOST: true+ ```++### 3. External Dependencies++#### LibSQL Database+- **Image**: `ghcr.io/tursodatabase/libsql-server:latest`+- **Port**: 8080+- **Environment Variables**:+ ```yaml+ SQLD_NODE: primary+ ```++#### TinyBird (Optional)+- **Image**: `tinybirdco/tinybird-local:latest`+- **Port**: 7181+- **Environment Variables**:+ ```yaml+ COMPATIBILITY_MODE: 1+ ```++### 4. Network Configuration++1. Create a shared network for all services+2. Ensure services can communicate using container names+3. Configure health checks for each service++### 5. Deployment Order++Deploy services in this order:+1. LibSQL (database)+2. TinyBird (if used)+3. Workflows+4. Server+5. Private Location+6. Checker+7. Dashboard+8. Status Page++## Environment Variables++Create a `.env` file with all required variables. Refer to `.env.docker.example` in the repository for the complete list.++## Health Checks++All images include built-in health checks:+- **Server/Workflows**: `curl -f http://localhost:3000/ping`+- **Dashboard/Status Page**: `curl -f http://localhost:3000/`+- **Private Location**: `wget --spider -q http://localhost:8080/health`+- **Checker**: `curl -f http://localhost:8080/health`++## Version Management++- `latest` tag points to the latest main branch build+- Development builds use `dev-latest` tag+- Specific commits are tagged with their SHA+- Use specific tags for production deployments++## Troubleshooting++### Image Pull Issues+Ensure Coolify has access to GitHub Container Registry:+1. Add GitHub token as a registry credential in Coolify+2. Use `GITHUB_TOKEN` with `packages: read` permissions++### Service Communication+- Verify all services are on the same network+- Check container names match the configuration+- Ensure ports are correctly mapped++### Database Connection+- Wait for LibSQL to be fully healthy before starting other services+- Verify the DATABASE_URL format: `http://libsql:8080`++## Updates++Images are automatically built and pushed when:+- Code is pushed to the main branch+- Manual workflow dispatch is triggered+- Weekly maintenance runs (Sundays 2 AM UTC)++To update in Coolify:+1. Pull new images+2. Redeploy services in the correct order+3. Verify health checks pass++## Support++- Check the GitHub Actions workflows for build status+- Review container logs in Coolify+- Open an issue for deployment problemsdiff --git a/COOLIFY_ENVIRONMENT_GUIDE.md b/COOLIFY_ENVIRONMENT_GUIDE.mdnew file mode 100644index 000000000..0ff3783d9--- /dev/null+++ b/COOLIFY_ENVIRONMENT_GUIDE.md@@ -0,0 +1,185 @@+# Coolify Environment Variables Setup Guide++This guide explains how to configure environment variables for OpenStatus deployment in Coolify.++## π Quick Setup++### Step 1: Import the Stack+1. In Coolify dashboard, click **"New Service"** β **"Docker Compose"**+2. Choose **"Import from URL"** and enter:+ ```+ https://raw.githubusercontent.com/aggmoulik/openstatus/main/coolify-deployment.yaml+ ```+3. Click **"Deploy"**++### Step 2: Configure Environment Variables+1. After deployment, click on the **OpenStatus stack**+2. Go to **"Settings"** β **"Environment Variables"**+3. Add the required variables below++## π§ Required Environment Variables++### **Core Database & Authentication**+```bash+# Database Connection+DATABASE_URL=http://libsql:8080+DATABASE_AUTH_TOKEN=++# Authentication+AUTH_SECRET=your-32-character-secret-here+NEXT_PUBLIC_URL=https://your-domain.com+SELF_HOST=true+```++### **Email Service (Required for Login)**+```bash+RESEND_API_KEY=re_your_resend_api_key_here+```++## π§ Optional Environment Variables++### **Analytics (TinyBird)**+```bash+TINY_BIRD_API_KEY=your_tinybird_api_key+TINYBIRD_URL=http://tinybird:7181+```++### **OAuth Providers**+```bash+# GitHub OAuth+AUTH_GITHUB_ID=your_github_oauth_id+AUTH_GITHUB_SECRET=your_github_oauth_secret++# Google OAuth+AUTH_GOOGLE_ID=your_google_oauth_id+AUTH_GOOGLE_SECRET=your_google_oauth_secret+```++### **Redis & Queue (Optional)**+```bash+UPSTASH_REDIS_REST_URL=http://localhost:6379+UPSTASH_REDIS_REST_TOKEN=your_redis_token+QSTASH_CURRENT_SIGNING_KEY=your_qstash_key+QSTASH_NEXT_SIGNING_KEY=your_qstash_key+QSTASH_TOKEN=your_qstash_token+QSTASH_URL=https://qstash.upstash.io/v1/publish/+```++### **Google Cloud (Optional)**+```bash+GCP_PROJECT_ID=your_gcp_project_id+GCP_LOCATION=your_gcp_location+GCP_CLIENT_EMAIL=your_gcp_service_account+GCP_PRIVATE_KEY=your_gcp_private_key+CRON_SECRET=your_cron_secret+```++### **API Keys (Optional)**+```bash+UNKEY_API_ID=your_unkey_api_id+UNKEY_TOKEN=your_unkey_token+SUPER_ADMIN_TOKEN=your_super_admin_token+FLY_REGION=self-hosted+```++### **Stripe (Optional)**+```bash+STRIPE_SECRET_KEY=sk_test_your_stripe_secret+STRIPE_WEBHOOK_SECRET_KEY=whsec_your_webhook_secret+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_your_publishable_key+```++### **Vercel (Optional)**+```bash+PROJECT_ID_VERCEL=your_vercel_project_id+TEAM_ID_VERCEL=your_vercel_team_id+VERCEL_AUTH_BEARER_TOKEN=your_vercel_token+BLOB_READ_WRITE_TOKEN=your_vercel_blob_token+```++### **Observability (Optional)**+```bash+NEXT_PUBLIC_SENTRY_DSN=your_sentry_dsn+SENTRY_AUTH_TOKEN=your_sentry_auth_token+NEXT_PUBLIC_OPENPANEL_CLIENT_ID=your_openpanel_client_id+OPENPANEL_CLIENT_SECRET=your_openpanel_client_secret+PAGERDUTY_APP_ID=your_pagerduty_app_id+SLACK_SUPPORT_WEBHOOK_URL=your_slack_webhook_url+TELEGRAM_BOT_TOKEN=your_telegram_bot_token+```++### **External Services (Optional)**+```bash+OPENSTATUS_INGEST_URL=https://openstatus-private-location.fly.dev+SCREENSHOT_SERVICE_URL=your_screenshot_service_url+```++### **Development & Testing (Optional)**+```bash+TURBO_ENV_MODE=loose+PLAYGROUND_UNKEY_API_KEY=your_playground_key+WORKSPACES_LOOKBACK_30=true+WORKSPACES_HIDE_URL=false+```++## π Environment Variable Visibility in Coolify++### **Where to Find Environment Variables**+1. **Stack Settings**: Click on your OpenStatus stack+2. **Environment Tab**: Look for "Environment Variables" section+3. **Add Variables**: Click "Add Variable" for each required variable+4. **Apply Changes**: Save and redeploy the stack++### **Variable Categories in Coolify UI**+- **Database**: `DATABASE_URL`, `DATABASE_AUTH_TOKEN`+- **Authentication**: `AUTH_SECRET`, `NEXT_PUBLIC_URL`, `SELF_HOST`+- **Email**: `RESEND_API_KEY`+- **Analytics**: `TINY_BIRD_API_KEY`, `TINYBIRD_URL`+- **OAuth**: `AUTH_GITHUB_*`, `AUTH_GOOGLE_*`+- **Queue**: `UPSTASH_*`, `QSTASH_*`+- **Cloud**: `GCP_*`, `CRON_SECRET`+- **API Keys**: `UNKEY_*`, `SUPER_ADMIN_TOKEN`, `FLY_REGION`+- **Payments**: `STRIPE_*`, `NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY`+- **Vercel**: `PROJECT_ID_VERCEL`, `TEAM_ID_VERCEL`, `VERCEL_*`+- **Observability**: `NEXT_PUBLIC_SENTRY_DSN`, `SENTRY_*`, `OPENPANEL_*`+- **External**: `OPENSTATUS_INGEST_URL`, `SCREENSHOT_SERVICE_URL`+- **Development**: `TURBO_ENV_MODE`, `PLAYGROUND_*`, `WORKSPACES_*`++## π¨ Troubleshooting++### **Environment Variables Not Working?**+1. **Check Stack Logs**: Look for environment variable errors+2. **Verify Variable Names**: Ensure exact match with this guide+3. **Redeploy**: Sometimes requires full stack restart+4. **Check Coolify Docs**: Some variables may need special handling++### **Common Issues**+- **DATABASE_URL**: Must be `http://libsql:8080` (internal container communication)+- **AUTH_SECRET**: Must be at least 32 characters+- **NEXT_PUBLIC_URL**: Must include protocol (http:// or https://)+- **RESEND_API_KEY**: Required for email login functionality++### **Getting Help**+- **Coolify Documentation**: Check Coolify's environment variables guide+- **OpenStatus Docs**: Visit [OpenStatus Documentation](https://github.com/openstatusHQ/openstatus)+- **Community Support**: Open an issue in the GitHub repository++## π― Production Deployment++### **Minimum Required Variables**+For a basic working deployment, you only need:+```bash+DATABASE_URL=http://libsql:8080+DATABASE_AUTH_TOKEN=+AUTH_SECRET=your-32-char-secret+NEXT_PUBLIC_URL=https://your-domain.com+RESEND_API_KEY=your-resend-key+```++### **Testing Your Setup**+1. Deploy with minimum variables first+2. Check if services start correctly+3. Add optional variables incrementally+4. Test each feature as you add variables++This ensures a smooth, working deployment! πdiff --git a/COOLIFY_SETUP.md b/COOLIFY_SETUP.mdnew file mode 100644index 000000000..f510f295d--- /dev/null+++ b/COOLIFY_SETUP.md@@ -0,0 +1,294 @@+# Coolify Setup Guide++This guide provides step-by-step instructions for deploying OpenStatus on Coolify using pre-built Docker images.++## Quick Start++### Option 1: Import Complete Stack++1. In Coolify dashboard, click **"New Service"** β **"Docker Compose"**+2. Choose **"Import from URL"** and enter:+ ```+ https://raw.githubusercontent.com/openstatusHQ/openstatus/main/coolify-deployment.yaml+ ```+3. Configure your environment variables+4. Click **"Deploy"**++### Option 2: Import with Environment Validation++1. In Coolify dashboard, click **"New Service"** β **"Docker Compose"**+2. Choose **"Import from URL"** and enter:+ ```+ https://raw.githubusercontent.com/openstatusHQ/openstatus/main/docker-compose.env-check.yaml+ ```+3. This version includes environment validation+4. Configure your environment variables+5. Click **"Deploy"**++### Option 3: Manual Service Setup++Create each service individually using the configurations below.++## Environment Setup++### Automatic Setup++1. **Clone the repository** to your local machine+2. **Run the setup script**:+ ```bash+ ./setup-env.sh+ ```+3. **Follow the prompts** to configure required variables+4. **Upload .env.docker** to Coolify secrets++### Manual Setup++1. **Copy the example file**:+ ```bash+ cp .env.docker.example .env.docker+ ```+2. **Edit the file** with your values:+ ```bash+ nano .env.docker+ ```+3. **Required variables**:+ - `DATABASE_URL=http://libsql:8080`+ - `AUTH_SECRET=your-32-char-secret`+ - `RESEND_API_KEY=your-resend-key`+ - `NEXT_PUBLIC_URL=http://your-domain:3002`++### Environment Validation++The `docker-compose.env-check.yaml` file includes:+- **Pre-start validation** of .env.docker existence+- **Required variable checks** before service startup+- **Clear error messages** for missing configuration+- **Dependency management** with validation service++## Service Configurations++### 1. Database Services++#### LibSQL Database+- **Image**: `ghcr.io/tursodatabase/libsql-server:latest`+- **Name**: `openstatus-libsql`+- **Port**: `8080`+- **Environment Variables**:+ ```+ SQLD_NODE=primary+ ```+- **Volumes**: `openstatus-libsql-data:/var/lib/sqld`+- **Health Check**: `curl -f http://localhost:8080`++#### TinyBird (Optional)+- **Image**: `tinybirdco/tinybird-local:latest`+- **Name**: `openstatus-tinybird`+- **Port**: `7181`+- **Environment Variables**:+ ```+ COMPATIBILITY_MODE=1+ ```++### 2. Core Services++#### Workflows Engine+- **Image**: `ghcr.io/openstatusHQ/openstatus-workflows:latest`+- **Name**: `openstatus-workflows`+- **Port**: `3000`+- **Environment Variables**:+ ```+ DATABASE_URL=http://libsql:8080+ PORT=3000+ NODE_ENV=production+ ```+- **Volumes**: `./data:/app/data`+- **Depends On**: `openstatus-libsql`++#### API Server+- **Image**: `ghcr.io/openstatusHQ/openstatus-server:latest`+- **Name**: `openstatus-server`+- **Port**: `3001`+- **Environment Variables**:+ ```+ DATABASE_URL=http://libsql:8080+ PORT=3000+ NODE_ENV=production+ ```+- **Depends On**: `openstatus-workflows`, `openstatus-libsql`++#### Private Location Agent+- **Image**: `ghcr.io/openstatusHQ/openstatus-private-location:latest`+- **Name**: `openstatus-private-location`+- **Port**: `8081`+- **Environment Variables**:+ ```+ DB_URL=http://libsql:8080+ TINYBIRD_URL=http://tinybird:7181+ GIN_MODE=release+ PORT=8080+ NODE_ENV=production+ ```+- **Depends On**: `openstatus-server`++#### Checker Service+- **Image**: `ghcr.io/openstatusHQ/openstatus-checker:latest`+- **Name**: `openstatus-checker`+- **Port**: `8082`+- **Environment Variables**:+ ```+ DATABASE_URL=http://libsql:8080+ PORT=8080+ NODE_ENV=production+ ```+- **Depends On**: `openstatus-server`++#### Web Dashboard+- **Image**: `ghcr.io/openstatusHQ/openstatus-dashboard:latest`+- **Name**: `openstatus-dashboard`+- **Port**: `3002`+- **Environment Variables**:+ ```+ DATABASE_URL=http://libsql:8080+ PORT=3000+ HOSTNAME=0.0.0.0+ AUTH_TRUST_HOST=true+ NODE_ENV=production+ ```+- **Depends On**: `openstatus-workflows`, `openstatus-libsql`, `openstatus-server`++#### Status Page+- **Image**: `ghcr.io/openstatusHQ/openstatus-status-page:latest`+- **Name**: `openstatus-status-page`+- **Port**: `3003`+- **Environment Variables**:+ ```+ DATABASE_URL=http://libsql:8080+ PORT=3000+ HOSTNAME=0.0.0.0+ AUTH_TRUST_HOST=true+ NODE_ENV=production+ ```+- **Depends On**: `openstatus-workflows`, `openstatus-libsql`, `openstatus-server`++## Environment Variables++Create a `.env.docker` file with the following variables:++```bash+# Database+DATABASE_URL=http://libsql:8080++# Authentication+NEXTAUTH_SECRET=your-secret-key-here+NEXTAUTH_URL=http://localhost:3002++# External Services+RESEND_API_KEY=your-resend-api-key+UPSTASH_REDIS_REST_URL=your-upstash-url+UPSTASH_REDIS_REST_TOKEN=your-upstash-token++# TinyBird+TINYBIRD_TOKEN=your-tinybird-token+TINYBIRD_URL=http://tinybird:7181++# Other+ENCRYPTION_KEY=your-encryption-key+```++## Network Configuration++1. **Create Network**: In Coolify, create a network named `openstatus`+2. **Attach Services**: Ensure all services are attached to this network+3. **Service Discovery**: Services can communicate using container names as hostnames++## Deployment Order++Deploy services in this sequence:++1. **libsql** (Database)+2. **tinybird** (Optional - Analytics)+3. **workflows** (Workflow Engine)+4. **server** (API Server)+5. **private-location** (Monitoring Agent)+6. **checker** (Health Checker)+7. **dashboard** (Web Interface)+8. **status-page** (Public Status)++## Resource Allocation++Recommended resource limits for each service:++| Service | Memory Limit | Memory Reservation |+|----------|---------------|-------------------|+| libsql | 512MB | 256MB |+| tinybird | 1GB | 512MB |+| workflows | 512MB | 256MB |+| server | 512MB | 256MB |+| private-location | 256MB | 128MB |+| checker | 256MB | 128MB |+| dashboard | 512MB | 256MB |+| status-page | 512MB | 256MB |++## Health Checks++All services include built-in health checks:++- **API Services**: `curl -f http://localhost:3000/ping`+- **Web Services**: `curl -f http://localhost:3000/`+- **Private Location**: `wget --spider -q http://localhost:8080/health`++## Access URLs++After deployment, access services at:++- **Dashboard**: `http://your-domain:3002`+- **API Server**: `http://your-domain:3001`+- **Status Page**: `http://your-domain:3003`+- **Workflows**: `http://your-domain:3000`++## Troubleshooting++### Common Issues++1. **Service Not Starting**+ - Check environment variables+ - Verify network connectivity+ - Review service logs++2. **Database Connection Failed**+ - Ensure libsql is healthy first+ - Check DATABASE_URL format+ - Verify network configuration++3. **Health Check Failing**+ - Wait for full startup (30-60 seconds)+ - Check if required ports are available+ - Review service dependencies++### Log Locations++In Coolify, access logs via:+1. Service β **Logs** tab+2. **Real-time** streaming logs+3. **Historical** log files++### Updates++To update services:+1. Pull new images in Coolify+2. Redeploy affected services+3. Verify health checks pass++## Production Considerations++1. **SSL/TLS**: Configure HTTPS in Coolify+2. **Backups**: Enable automated backups for database+3. **Monitoring**: Set up external monitoring+4. **Scaling**: Configure resource limits based on usage+5. **Security**: Update images regularly, use secrets management++## Support++- **Documentation**: [OpenStatus Docs](https://docs.openstatus.dev)+- **Issues**: [GitHub Issues](https://github.com/openstatusHQ/openstatus/issues)+- **Community**: [Discord](https://www.openstatus.dev/discord)diff --git a/README.md b/README.mdindex 98c860aa3..6fd26bd87 100644--- a/README.md+++ b/README.md@@ -85,6 +85,22 @@ Made with [Contrib.rocks](https://contrib.rocks)[](https://depot.dev/?utm_source=Opource=OpenStatus)+## Quick Start with Coolify π++We provide pre-built Docker images for easy deployment with Coolify:++```bash+# Example Coolify configuration+ghcr.io/openstatusHQ/openstatus-server:latest+ghcr.io/openstatusHQ/openstatus-dashboard:latest+ghcr.io/openstatusHQ/openstatus-workflows:latest+ghcr.io/openstatusHQ/openstatus-private-location:latest+ghcr.io/openstatusHQ/openstatus-status-page:latest+ghcr.io/openstatusHQ/openstatus-checker:latest+```++π **[Complete Coolify Deployment Guide](./COOLIFY_DEPLOYMENT.md)**+## Getting Started π### With Docker (Recommended)diff --git a/coolify-deployment.yaml b/coolify-deployment.yamlnew file mode 100644index 000000000..fef2682e8--- /dev/null+++ b/coolify-deployment.yaml@@ -0,0 +1,345 @@+# Coolify Deployment Configuration+# This file uses environment variables that can be configured directly in Coolify+#+# π§ REQUIRED: Set these environment variables in Coolify:+# DATABASE_URL=http://libsql:8080+# DATABASE_AUTH_TOKEN= (leave empty for local libsql)+# AUTH_SECRET=your-32-character-secret+# NEXT_PUBLIC_URL=https://your-domain.com+# RESEND_API_KEY=your-resend-api-key+#+# π Full Guide: See COOLIFY_ENVIRONMENT_GUIDE.md+#+# π Quick Import URL:+# https://raw.githubusercontent.com/openstatusHQ/openstatus/main/coolify-deployment.yaml++version: "3.8"++# Environment variable definitions with defaults+x-common-variables: &common-env+ # Database Configuration+ DATABASE_URL: ${DATABASE_URL:-http://libsql:8080}+ DATABASE_AUTH_TOKEN: ${DATABASE_AUTH_TOKEN:-}++ # Authentication+ AUTH_SECRET: ${AUTH_SECRET:-default-secret-change-me}+ NEXT_PUBLIC_URL: ${NEXT_PUBLIC_URL:-http://localhost:3002}+ SELF_HOST: ${SELF_HOST:-true}++ # OAuth Providers (Optional)+ AUTH_GITHUB_ID: ${AUTH_GITHUB_ID:-}+ AUTH_GITHUB_SECRET: ${AUTH_GITHUB_SECRET:-}+ AUTH_GOOGLE_ID: ${AUTH_GOOGLE_ID:-}+ AUTH_GOOGLE_SECRET: ${AUTH_GOOGLE_SECRET:-}++ # Email Service+ RESEND_API_KEY: ${RESEND_API_KEY:-}++ # Analytics (Optional)+ TINY_BIRD_API_KEY: ${TINY_BIRD_API_KEY:-}+ TINYBIRD_URL: ${TINYBIRD_URL:-}++ # Redis/Queue (Optional)+ UPSTASH_REDIS_REST_URL: ${UPSTASH_REDIS_REST_URL:-http://localhost:6379}+ UPSTASH_REDIS_REST_TOKEN: ${UPSTASH_REDIS_REST_TOKEN:-}+ QSTASH_CURRENT_SIGNING_KEY: ${QSTASH_CURRENT_SIGNING_KEY:-}+ QSTASH_NEXT_SIGNING_KEY: ${QSTASH_NEXT_SIGNING_KEY:-}+ QSTASH_TOKEN: ${QSTASH_TOKEN:-}+ QSTASH_URL: ${QSTASH_URL:-https://qstash.upstash.io/v1/publish/}++ # Google Cloud (Optional)+ GCP_PROJECT_ID: ${GCP_PROJECT_ID:-}+ GCP_LOCATION: ${GCP_LOCATION:-}+ GCP_CLIENT_EMAIL: ${GCP_CLIENT_EMAIL:-}+ GCP_PRIVATE_KEY: ${GCP_PRIVATE_KEY:-}+ CRON_SECRET: ${CRON_SECRET:-}++ # API Keys (Optional)+ UNKEY_API_ID: ${UNKEY_API_ID:-}+ UNKEY_TOKEN: ${UNKEY_TOKEN:-}+ SUPER_ADMIN_TOKEN: ${SUPER_ADMIN_TOKEN:-}+ FLY_REGION: ${FLY_REGION:-self-hosted}++ # Stripe (Optional)+ STRIPE_SECRET_KEY: ${STRIPE_SECRET_KEY:-}+ STRIPE_WEBHOOK_SECRET_KEY: ${STRIPE_WEBHOOK_SECRET_KEY:-}+ NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY: ${NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY:-}++ # Vercel (Optional)+ PROJECT_ID_VERCEL: ${PROJECT_ID_VERCEL:-}+ TEAM_ID_VERCEL: ${TEAM_ID_VERCEL:-}+ VERCEL_AUTH_BEARER_TOKEN: ${VERCEL_AUTH_BEARER_TOKEN:-}+ BLOB_READ_WRITE_TOKEN: ${BLOB_READ_WRITE_TOKEN:-}++ # Observability (Optional)+ NEXT_PUBLIC_SENTRY_DSN: ${NEXT_PUBLIC_SENTRY_DSN:-}+ SENTRY_AUTH_TOKEN: ${SENTRY_AUTH_TOKEN:-}+ NEXT_PUBLIC_OPENPANEL_CLIENT_ID: ${NEXT_PUBLIC_OPENPANEL_CLIENT_ID:-}+ OPENPANEL_CLIENT_SECRET: ${OPENPANEL_CLIENT_SECRET:-}+ PAGERDUTY_APP_ID: ${PAGERDUTY_APP_ID:-}+ SLACK_SUPPORT_WEBHOOK_URL: ${SLACK_SUPPORT_WEBHOOK_URL:-}+ TELEGRAM_BOT_TOKEN: ${TELEGRAM_BOT_TOKEN:-}++ # External Services+ OPENSTATUS_INGEST_URL: ${OPENSTATUS_INGEST_URL:-https://openstatus-private-location.fly.dev}+ SCREENSHOT_SERVICE_URL: ${SCREENSHOT_SERVICE_URL:-}++ # Development & Testing+ TURBO_ENV_MODE: ${TURBO_ENV_MODE:-loose}+ PLAYGROUND_UNKEY_API_KEY: ${PLAYGROUND_UNKEY_API_KEY:-}+ WORKSPACES_LOOKBACK_30: ${WORKSPACES_LOOKBACK_30:-}+ WORKSPACES_HIDE_URL: ${WORKSPACES_HIDE_URL:-}++ # Common Settings+ NODE_ENV: ${NODE_ENV:-production}+ ENCRYPTION_KEY: ${ENCRYPTION_KEY:-default-encryption-key}++x-service-variables: &service-env+ <<: *common-env+ PORT: ${PORT:-3000}++networks:+ openstatus:+ driver: bridge+ name: openstatus++volumes:+ libsql-data:+ name: openstatus-libsql-data++services:+ # External Dependencies+ libsql:+ image: ghcr.io/tursodatabase/libsql-server:latest+ container_name: openstatus-libsql+ networks:+ - openstatus+ ports:+ - "8085:8080"+ - "5001:5001"+ volumes:+ - libsql-data:/var/lib/sqld+ environment:+ - SQLD_NODE=primary+ healthcheck:+ test: ["CMD", "sh", "-c", "perl -e 'use IO::Socket::INET; exit(IO::Socket::INET->new(PeerAddr=>\"127.0.0.1:8080\",Timeout=>1) ? 0 : 1);'"]+ interval: 10s+ timeout: 5s+ retries: 5+ start_period: 10s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 512M+ reservations:+ memory: 256M++ tinybird:+ image: tinybirdco/tinybird-local:latest+ container_name: openstatus-tinybird+ networks:+ - openstatus+ ports:+ - "7181:7181"+ environment:+ - COMPATIBILITY_MODE=1+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:7181/"]+ interval: 15s+ timeout: 5s+ retries: 5+ start_period: 20s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 1G+ reservations:+ memory: 512M++ # Core OpenStatus Services+ workflows:+ image: ghcr.io/openstatushq/openstatus-workflows:dev-latest-workflows+ container_name: openstatus-workflows+ networks:+ - openstatus+ ports:+ - "3000:3000"+ volumes:+ - ./data:/app/data+ environment:+ - DATABASE_URL=${DATABASE_URL:-http://libsql:8080}+ - DATABASE_AUTH_TOKEN=${DATABASE_AUTH_TOKEN:-}+ - PORT=${WORKFLOWS_PORT:-3000}+ depends_on:+ libsql:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:3000/ping"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 512M+ reservations:+ memory: 256M++ server:+ image: ghcr.io/openstatusHQ/openstatus-server:dev-latest-server+ container_name: openstatus-server+ networks:+ - openstatus+ ports:+ - "3001:3000"+ environment:+ - DATABASE_URL=${DATABASE_URL:-http://libsql:8080}+ - DATABASE_AUTH_TOKEN=${DATABASE_AUTH_TOKEN:-}+ - PORT=${SERVER_PORT:-3000}+ depends_on:+ libsql:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:3000/ping"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 512M+ reservations:+ memory: 256M++ private-location:+ image: ghcr.io/openstatusHQ/openstatus-private-location:dev-latest-private-location+ container_name: openstatus-private-location+ networks:+ - openstatus+ ports:+ - "8083:8080"+ environment:+ - DB_URL=${DATABASE_URL:-http://libsql:8080}+ - TINYBIRD_URL=${TINYBIRD_URL:-http://tinybird:7181}+ - GIN_MODE=release+ - PORT=${PRIVATE_LOCATION_PORT:-8080}+ depends_on:+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "wget", "--spider", "-q", "http://localhost:8080/health"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 256M+ reservations:+ memory: 128M++ checker:+ image: ghcr.io/openstatusHQ/openstatus-checker:dev-latest-checker+ container_name: openstatus-checker+ networks:+ - openstatus+ ports:+ - "8082:8080"+ environment:+ - DATABASE_URL=${DATABASE_URL:-http://libsql:8080}+ - DATABASE_AUTH_TOKEN=${DATABASE_AUTH_TOKEN:-}+ - PORT=${CHECKER_PORT:-8080}+ depends_on:+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:8080/health"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 256M+ reservations:+ memory: 128M++ dashboard:+ image: ghcr.io/openstatusHQ/openstatus-dashboard:dev-latest-dashboard+ container_name: openstatus-dashboard+ networks:+ - openstatus+ ports:+ - "3002:3000"+ environment:+ - DATABASE_URL=${DATABASE_URL:-http://libsql:8080}+ - DATABASE_AUTH_TOKEN=${DATABASE_AUTH_TOKEN:-}+ - PORT=${DASHBOARD_PORT:-3000}+ - HOSTNAME=${DASHBOARD_HOSTNAME:-0.0.0.0}+ - AUTH_TRUST_HOST=${DASHBOARD_AUTH_TRUST_HOST:-true}+ depends_on:+ libsql:+ condition: service_healthy+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:3000/"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 45s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 512M+ reservations:+ memory: 256M++ status-page:+ image: ghcr.io/openstatusHQ/openstatus-status-page:dev-latest-status-page+ container_name: openstatus-status-page+ networks:+ - openstatus+ ports:+ - "3003:3000"+ environment:+ - DATABASE_URL=${DATABASE_URL:-http://libsql:8080}+ - DATABASE_AUTH_TOKEN=${DATABASE_AUTH_TOKEN:-}+ - PORT=${STATUS_PAGE_PORT:-3000}+ - HOSTNAME=${STATUS_PAGE_HOSTNAME:-0.0.0.0}+ - AUTH_TRUST_HOST=${STATUS_PAGE_AUTH_TRUST_HOST:-true}+ depends_on:+ libsql:+ condition: service_healthy+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:3000/"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 45s+ restart: unless-stopped+ deploy:+ resources:+ limits:+ memory: 512M+ reservations:+ memory: 256M++# Coolify-specific labels for better management+x-coolify-labels:+ app: openstatus+ version: "1.0"+ environment: productiondiff --git a/docker-compose.github-packages.yaml b/docker-compose.github-packages.yamlnew file mode 100644index 000000000..d231ca07f--- /dev/null+++ b/docker-compose.github-packages.yaml@@ -0,0 +1,216 @@+networks:+ openstatus:+ driver: bridge+ name: openstatus++volumes:+ libsql-data:+ name: openstatus-libsql-data++services:+ # External services+ libsql:+ container_name: openstatus-libsql+ image: ghcr.io/tursodatabase/libsql-server:latest+ networks:+ - openstatus+ ports:+ - "8080:8080"+ - "5001:5001"+ volumes:+ - libsql-data:/var/lib/sqld+ environment:+ - SQLD_NODE=primary+ healthcheck:+ test:+ [+ "CMD-SHELL",+ 'perl -e ''use IO::Socket::INET; exit(IO::Socket::INET->new(PeerAddr=>"127.0.0.1:8080",Timeout=>1) ? 0 : 1);''',+ ]+ interval: 10s+ timeout: 5s+ retries: 5+ start_period: 10s+ restart: unless-stopped++ tinybird-local:+ container_name: openstatus-tinybird+ image: tinybirdco/tinybird-local:latest+ platform: linux/amd64+ networks:+ - openstatus+ ports:+ - "7181:7181"+ environment:+ - COMPATIBILITY_MODE=1+ healthcheck:+ test: ["CMD", "curl", "-f", "http://localhost:7181/"]+ interval: 15s+ timeout: 5s+ retries: 5+ start_period: 20s+ restart: unless-stopped++ # Internal Services - Using GitHub Packages+ workflows:+ container_name: openstatus-workflows+ image: ghcr.io/openstatusHQ/openstatus-workflows:latest+ networks:+ - openstatus+ ports:+ - "3000:3000"+ volumes:+ - ./data:/app/data+ env_file:+ - .env.docker+ environment:+ - DATABASE_URL=http://libsql:8080+ - PORT=3000+ depends_on:+ libsql:+ condition: service_healthy+ healthcheck:+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ping || exit 1"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped++ server:+ container_name: openstatus-server+ image: ghcr.io/openstatusHQ/openstatus-server:latest+ networks:+ - openstatus+ ports:+ - "3001:3000"+ env_file:+ - .env.docker+ environment:+ - DATABASE_URL=http://libsql:8080+ - PORT=3000+ depends_on:+ workflows:+ condition: service_healthy+ libsql:+ condition: service_healthy+ healthcheck:+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ping || exit 1"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped++ private-location:+ container_name: openstatus-private-location+ image: ghcr.io/openstatusHQ/openstatus-private-location:latest+ networks:+ - openstatus+ ports:+ - "8081:8080"+ env_file:+ - .env.docker+ environment:+ - DB_URL=http://libsql:8080+ - TINYBIRD_URL=http://tinybird-local:7181+ - GIN_MODE=release+ - PORT=8080+ depends_on:+ server:+ condition: service_healthy+ healthcheck:+ test:+ [+ "CMD",+ "wget",+ "--spider",+ "-q",+ "http://localhost:8080/health",+ ]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped++ checker:+ container_name: openstatus-checker+ image: ghcr.io/openstatusHQ/openstatus-checker:latest+ networks:+ - openstatus+ ports:+ - "8082:8080"+ env_file:+ - .env.docker+ environment:+ - DATABASE_URL=http://libsql:8080+ - PORT=8080+ depends_on:+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD-SHELL", "curl -f http://localhost:8080/health || exit 1"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 30s+ restart: unless-stopped++ dashboard:+ container_name: openstatus-dashboard+ image: ghcr.io/openstatusHQ/openstatus-dashboard:latest+ networks:+ - openstatus+ ports:+ - "3002:3000"+ env_file:+ - .env.docker+ environment:+ - DATABASE_URL=http://libsql:8080+ - PORT=3000+ - HOSTNAME=0.0.0.0+ - AUTH_TRUST_HOST=true+ depends_on:+ workflows:+ condition: service_healthy+ libsql:+ condition: service_healthy+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 45s+ restart: unless-stopped++ status-page:+ container_name: openstatus-status-page+ image: ghcr.io/openstatusHQ/openstatus-status-page:latest+ networks:+ - openstatus+ ports:+ - "3003:3000"+ env_file:+ - .env.docker+ environment:+ - DATABASE_URL=http://libsql:8080+ - PORT=3000+ - HOSTNAME=0.0.0.0+ - AUTH_TRUST_HOST=true+ depends_on:+ workflows:+ condition: service_healthy+ libsql:+ condition: service_healthy+ server:+ condition: service_healthy+ healthcheck:+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]+ interval: 15s+ timeout: 10s+ retries: 3+ start_period: 45s+ restart: unless-stopped