mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
feat: an option to setup remote server with docker compose build (#280)
* feat: remote setup with docker build option * chore: update documentation * chore: make script run in non tty * chore: add warning about slow build * chore: add more documentation * feat: add FASTAPI_WORKERS parameter * feat: add scaling docs * feat: add update script * fix: fix semver options in update_remote.sh
This commit is contained in:
Abhishek
GitHub
parent
b670004725
commit
59619e9eaa
10 changed files with 1086 additions and 145 deletions
|
|
@ -44,30 +44,208 @@ if [[ -z "$TURN_SECRET" ]]; then
|
|||
echo -e "${BLUE}Generated random TURN secret${NC}"
|
||||
fi
|
||||
|
||||
# Deployment mode. Skip prompt if DEPLOY_MODE is already set. Non-interactive
|
||||
# callers (cloud-init, CI, terraform) without a TTY default to "prebuilt" so
|
||||
# existing automation keeps working without changes - explicitly set
|
||||
# DEPLOY_MODE=build to opt into source builds from a non-interactive context.
|
||||
if [[ -z "$DEPLOY_MODE" ]]; then
|
||||
if [[ -t 0 ]]; then
|
||||
echo ""
|
||||
echo -e "${YELLOW}Deployment mode:${NC}"
|
||||
echo " 1) prebuilt - pull official dograh images (recommended, fastest)"
|
||||
echo " 2) build - build images from source (for forks or local customizations)"
|
||||
read -p "Choose [1]: " mode_choice
|
||||
mode_choice="${mode_choice:-1}"
|
||||
case "$mode_choice" in
|
||||
1|prebuilt) DEPLOY_MODE="prebuilt" ;;
|
||||
2|build) DEPLOY_MODE="build" ;;
|
||||
*) echo -e "${RED}Error: invalid choice '$mode_choice'${NC}"; exit 1 ;;
|
||||
esac
|
||||
else
|
||||
DEPLOY_MODE="prebuilt"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Build mode needs source code - either use existing repo or clone fresh.
|
||||
# Same TTY rule: prompt interactively, otherwise pick sensible defaults so
|
||||
# automation that sets DEPLOY_MODE=build doesn't need to spell everything out.
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
if [[ -z "$REPO_SOURCE" ]]; then
|
||||
if [[ -d ".git" ]] && [[ -f "docker-compose.yaml" ]]; then
|
||||
if [[ -t 0 ]]; then
|
||||
echo ""
|
||||
echo -e "${YELLOW}Detected a git repo with docker-compose.yaml in $(pwd).${NC}"
|
||||
read -p "Build from this repo? [Y/n]: " use_existing
|
||||
use_existing="${use_existing:-Y}"
|
||||
if [[ "$use_existing" =~ ^[Yy] ]]; then
|
||||
REPO_SOURCE="existing"
|
||||
else
|
||||
REPO_SOURCE="clone"
|
||||
fi
|
||||
else
|
||||
REPO_SOURCE="existing"
|
||||
fi
|
||||
else
|
||||
REPO_SOURCE="clone"
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ "$REPO_SOURCE" == "clone" ]]; then
|
||||
if [[ -z "$FORK_REPO" ]]; then
|
||||
if [[ -t 0 ]]; then
|
||||
echo ""
|
||||
echo -e "${YELLOW}GitHub repo to clone (format: owner/name):${NC}"
|
||||
read -p "[dograh-hq/dograh]: " FORK_REPO
|
||||
FORK_REPO="${FORK_REPO:-dograh-hq/dograh}"
|
||||
else
|
||||
FORK_REPO="dograh-hq/dograh"
|
||||
fi
|
||||
fi
|
||||
if [[ -z "$BRANCH" ]]; then
|
||||
if [[ -t 0 ]]; then
|
||||
echo -e "${YELLOW}Branch:${NC}"
|
||||
read -p "[main]: " BRANCH
|
||||
BRANCH="${BRANCH:-main}"
|
||||
else
|
||||
BRANCH="main"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
# Telemetry opt-out (default: true)
|
||||
ENABLE_TELEMETRY="${ENABLE_TELEMETRY:-true}"
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}Configuration:${NC}"
|
||||
echo -e " Server IP: ${BLUE}$SERVER_IP${NC}"
|
||||
echo -e " TURN Secret: ${BLUE}********${NC}"
|
||||
echo ""
|
||||
|
||||
# Create project directory and download compose file (skip when
|
||||
# DOGRAH_SKIP_DOWNLOAD=1 — e.g. e2e tests that already have a cloned repo).
|
||||
if [[ "$DOGRAH_SKIP_DOWNLOAD" != "1" ]]; then
|
||||
mkdir -p dograh 2>/dev/null || true
|
||||
cd dograh
|
||||
|
||||
echo -e "${BLUE}[1/5] Downloading docker-compose.yaml...${NC}"
|
||||
curl -sS -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml
|
||||
echo -e "${GREEN}✓ docker-compose.yaml downloaded${NC}"
|
||||
else
|
||||
echo -e "${BLUE}[1/5] Using docker-compose.yaml in current directory${NC}"
|
||||
# Number of uvicorn worker processes. Each runs as its own process on a
|
||||
# distinct port (8000, 8001, ...) and nginx balances across them with
|
||||
# least_conn. Better than uvicorn --workers for long-lived WebSocket
|
||||
# connections, which would otherwise stick to whichever worker accepted them.
|
||||
if [[ -z "$FASTAPI_WORKERS" ]]; then
|
||||
if [[ -t 0 ]]; then
|
||||
echo ""
|
||||
echo -e "${YELLOW}Number of FastAPI workers (uvicorn processes nginx will load-balance):${NC}"
|
||||
read -p "[4]: " FASTAPI_WORKERS
|
||||
FASTAPI_WORKERS="${FASTAPI_WORKERS:-4}"
|
||||
else
|
||||
FASTAPI_WORKERS="4"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}[2/5] Creating nginx.conf...${NC}"
|
||||
cat > nginx.conf << 'NGINX_EOF'
|
||||
if ! [[ "$FASTAPI_WORKERS" =~ ^[1-9][0-9]*$ ]]; then
|
||||
echo -e "${RED}Error: FASTAPI_WORKERS must be a positive integer (got: $FASTAPI_WORKERS)${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Where setup artifacts (.env, certs, nginx.conf, etc.) will land. Build mode
|
||||
# with an existing repo writes them next to docker-compose.yaml in cwd;
|
||||
# everything else writes into a fresh dograh/ subdirectory.
|
||||
if [[ "$DEPLOY_MODE" == "build" && "$REPO_SOURCE" == "existing" ]]; then
|
||||
TARGET_DIR="."
|
||||
else
|
||||
TARGET_DIR="dograh"
|
||||
fi
|
||||
|
||||
# Refuse to overwrite an existing install - re-running this script would
|
||||
# regenerate OSS_JWT_SECRET (invalidating logged-in sessions), reset the
|
||||
# TURN secret (breaking WebRTC auth), and overwrite nginx.conf customizations.
|
||||
# Set DOGRAH_FORCE_OVERWRITE=1 to bypass; DOGRAH_SKIP_DOWNLOAD=1 (used by e2e)
|
||||
# also bypasses since those flows manage state themselves.
|
||||
if [[ "$DOGRAH_FORCE_OVERWRITE" != "1" && "$DOGRAH_SKIP_DOWNLOAD" != "1" ]]; then
|
||||
if [[ -f "$TARGET_DIR/.env" ]]; then
|
||||
if [[ "$TARGET_DIR" == "." ]]; then
|
||||
existing_path="$(pwd)/.env"
|
||||
else
|
||||
existing_path="$(pwd)/$TARGET_DIR/.env"
|
||||
fi
|
||||
echo ""
|
||||
echo -e "${YELLOW}Detected an existing Dograh install:${NC}"
|
||||
echo -e " ${YELLOW}$existing_path${NC}"
|
||||
echo ""
|
||||
echo -e "${RED}Refusing to continue - re-running setup would:${NC}"
|
||||
echo -e "${RED} - overwrite .env (invalidates sessions, breaks TURN auth)${NC}"
|
||||
echo -e "${RED} - regenerate SSL certificates${NC}"
|
||||
echo -e "${RED} - reset nginx.conf and turnserver.conf customizations${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}To upgrade an existing install, follow:${NC}"
|
||||
echo -e " ${BLUE}https://docs.dograh.com/deployment/update${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}To wipe state and reinstall from scratch, re-run with:${NC}"
|
||||
echo -e " ${BLUE}DOGRAH_FORCE_OVERWRITE=1 <same command>${NC}"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Total step count depends on mode (build adds the override-file step)
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
TOTAL=7
|
||||
else
|
||||
TOTAL=6
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}Configuration:${NC}"
|
||||
echo -e " Server IP: ${BLUE}$SERVER_IP${NC}"
|
||||
echo -e " TURN Secret: ${BLUE}********${NC}"
|
||||
echo -e " Deploy mode: ${BLUE}$DEPLOY_MODE${NC}"
|
||||
echo -e " FastAPI workers: ${BLUE}$FASTAPI_WORKERS${NC} (ports 8000..$((8000 + FASTAPI_WORKERS - 1)))"
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
if [[ "$REPO_SOURCE" == "clone" ]]; then
|
||||
echo -e " Source: ${BLUE}clone $FORK_REPO@$BRANCH${NC}"
|
||||
else
|
||||
echo -e " Source: ${BLUE}existing repo at $(pwd)${NC}"
|
||||
fi
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# Step 1: get the source - either the standalone compose file (prebuilt mode)
|
||||
# or the full repo (build mode). Skip the download/clone when
|
||||
# DOGRAH_SKIP_DOWNLOAD=1 (e.g. e2e tests that already have everything in place).
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
if [[ "$DOGRAH_SKIP_DOWNLOAD" == "1" ]]; then
|
||||
echo -e "${BLUE}[1/$TOTAL] Using existing repo in current directory${NC}"
|
||||
elif [[ "$REPO_SOURCE" == "clone" ]]; then
|
||||
if [[ -e "dograh" ]]; then
|
||||
echo -e "${RED}Error: 'dograh' directory already exists. Remove it or re-run with REPO_SOURCE=existing from inside it.${NC}"
|
||||
exit 1
|
||||
fi
|
||||
echo -e "${BLUE}[1/$TOTAL] Cloning $FORK_REPO (branch: $BRANCH)...${NC}"
|
||||
git clone --branch "$BRANCH" --recurse-submodules "https://github.com/$FORK_REPO.git" dograh
|
||||
cd dograh
|
||||
echo -e "${GREEN}✓ Repo cloned${NC}"
|
||||
else
|
||||
echo -e "${BLUE}[1/$TOTAL] Using existing repo at $(pwd)${NC}"
|
||||
fi
|
||||
else
|
||||
if [[ "$DOGRAH_SKIP_DOWNLOAD" != "1" ]]; then
|
||||
mkdir -p dograh 2>/dev/null || true
|
||||
cd dograh
|
||||
|
||||
echo -e "${BLUE}[1/$TOTAL] Downloading docker-compose.yaml...${NC}"
|
||||
curl -sS -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml
|
||||
echo -e "${GREEN}✓ docker-compose.yaml downloaded${NC}"
|
||||
else
|
||||
echo -e "${BLUE}[1/$TOTAL] Using docker-compose.yaml in current directory${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}[2/$TOTAL] Creating nginx.conf...${NC}"
|
||||
# Build the upstream block first (needs shell interpolation for the server
|
||||
# lines), then append the static server blocks via a quoted heredoc. The
|
||||
# SERVER_IP_PLACEHOLDER gets replaced by sed below.
|
||||
{
|
||||
echo "# Backend API workers — one uvicorn process per port, balanced by least_conn."
|
||||
echo "# Generated by setup_remote.sh; regenerate to change worker count."
|
||||
echo "upstream dograh_api {"
|
||||
echo " least_conn;"
|
||||
for ((i=0; i<FASTAPI_WORKERS; i++)); do
|
||||
port=$((8000 + i))
|
||||
echo " server api:$port max_fails=3 fail_timeout=10s;"
|
||||
done
|
||||
echo " keepalive 32;"
|
||||
echo "}"
|
||||
echo ""
|
||||
cat << 'NGINX_EOF'
|
||||
server {
|
||||
listen 80;
|
||||
server_name SERVER_IP_PLACEHOLDER;
|
||||
|
|
@ -87,11 +265,15 @@ server {
|
|||
ssl_protocols TLSv1.2 TLSv1.3;
|
||||
ssl_prefer_server_ciphers on;
|
||||
|
||||
# Backend API and WebSockets — bypass the UI, go straight to api:8000
|
||||
# Backend API and WebSockets - bypass the UI, go straight to the
|
||||
# api workers via the least_conn upstream defined above.
|
||||
location /api/v1/ {
|
||||
proxy_pass http://api:8000;
|
||||
proxy_pass http://dograh_api;
|
||||
proxy_http_version 1.1;
|
||||
|
||||
# Retry on a dead/restarting worker
|
||||
proxy_next_upstream error timeout http_502 http_503 http_504;
|
||||
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
|
||||
|
|
@ -145,12 +327,13 @@ server {
|
|||
}
|
||||
}
|
||||
NGINX_EOF
|
||||
} > nginx.conf
|
||||
|
||||
# Replace placeholder with actual IP
|
||||
sed -i.bak "s/SERVER_IP_PLACEHOLDER/$SERVER_IP/g" nginx.conf && rm -f nginx.conf.bak
|
||||
echo -e "${GREEN}✓ nginx.conf created${NC}"
|
||||
|
||||
echo -e "${BLUE}[3/5] Creating SSL certificate generation script...${NC}"
|
||||
echo -e "${BLUE}[3/$TOTAL] Creating SSL certificate generation script...${NC}"
|
||||
cat > generate_certificate.sh << CERT_EOF
|
||||
#!/bin/bash
|
||||
mkdir -p certs
|
||||
|
|
@ -163,11 +346,11 @@ CERT_EOF
|
|||
chmod +x generate_certificate.sh
|
||||
echo -e "${GREEN}✓ generate_certificate.sh created${NC}"
|
||||
|
||||
echo -e "${BLUE}[4/5] Generating SSL certificates...${NC}"
|
||||
echo -e "${BLUE}[4/$TOTAL] Generating SSL certificates...${NC}"
|
||||
./generate_certificate.sh
|
||||
echo -e "${GREEN}✓ SSL certificates generated${NC}"
|
||||
|
||||
echo -e "${BLUE}[5/6] Creating TURN server configuration...${NC}"
|
||||
echo -e "${BLUE}[5/$TOTAL] Creating TURN server configuration...${NC}"
|
||||
cat > turnserver.conf << TURN_EOF
|
||||
# Coturn TURN Server - Docker Configuration
|
||||
# Auto-generated by setup_remote.sh
|
||||
|
|
@ -200,7 +383,7 @@ log-file=stdout
|
|||
TURN_EOF
|
||||
echo -e "${GREEN}✓ turnserver.conf created${NC}"
|
||||
|
||||
echo -e "${BLUE}[6/6] Creating environment file...${NC}"
|
||||
echo -e "${BLUE}[6/$TOTAL] Creating environment file...${NC}"
|
||||
OSS_JWT_SECRET=$(openssl rand -hex 32)
|
||||
|
||||
cat > .env << ENV_EOF
|
||||
|
|
@ -222,9 +405,43 @@ OSS_JWT_SECRET=$OSS_JWT_SECRET
|
|||
|
||||
# Telemetry (set to false to disable)
|
||||
ENABLE_TELEMETRY=$ENABLE_TELEMETRY
|
||||
|
||||
# Number of uvicorn worker processes; nginx load-balances across them
|
||||
# (ports 8000..$((8000 + FASTAPI_WORKERS - 1))) with least_conn.
|
||||
# Must match the upstream block in nginx.conf — re-run setup_remote.sh
|
||||
# (with DOGRAH_FORCE_OVERWRITE=1) to change.
|
||||
FASTAPI_WORKERS=$FASTAPI_WORKERS
|
||||
ENV_EOF
|
||||
echo -e "${GREEN}✓ .env file created${NC}"
|
||||
|
||||
# In build mode, write the override file that swaps prebuilt images for
|
||||
# local builds. Compose auto-loads docker-compose.override.yaml, so no -f flag
|
||||
# is needed at runtime.
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
echo -e "${BLUE}[7/$TOTAL] Creating docker-compose.override.yaml...${NC}"
|
||||
cat > docker-compose.override.yaml << 'OVERRIDE_EOF'
|
||||
# Auto-generated by setup_remote.sh (build mode).
|
||||
# Overrides docker-compose.yaml to build api and ui images from local source
|
||||
# instead of pulling them from a registry. Remove this file to revert to
|
||||
# pulling prebuilt images.
|
||||
services:
|
||||
api:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: api/Dockerfile
|
||||
image: dograh-local/dograh-api:local
|
||||
pull_policy: never
|
||||
|
||||
ui:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ui/Dockerfile
|
||||
image: dograh-local/dograh-ui:local
|
||||
pull_policy: never
|
||||
OVERRIDE_EOF
|
||||
echo -e "${GREEN}✓ docker-compose.override.yaml created${NC}"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}╔══════════════════════════════════════════════════════════════╗${NC}"
|
||||
echo -e "${GREEN}║ Setup Complete! ║${NC}"
|
||||
|
|
@ -232,6 +449,9 @@ echo -e "${GREEN}╚════════════════════
|
|||
echo ""
|
||||
echo -e "Files created in ${BLUE}$(pwd)${NC}:"
|
||||
echo " - docker-compose.yaml"
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
echo " - docker-compose.override.yaml (build directives)"
|
||||
fi
|
||||
echo " - nginx.conf"
|
||||
echo " - turnserver.conf"
|
||||
echo " - generate_certificate.sh"
|
||||
|
|
@ -241,7 +461,29 @@ echo " - .env"
|
|||
echo ""
|
||||
echo -e "${YELLOW}To start Dograh, run:${NC}"
|
||||
echo ""
|
||||
echo -e " ${BLUE}sudo docker compose --profile remote up --pull always${NC}"
|
||||
# The script's own cd into dograh/ doesn't persist to the user's shell, so
|
||||
# remind them to cd themselves — except when they're already there (build mode
|
||||
# with REPO_SOURCE=existing, which writes into cwd).
|
||||
if [[ "$DEPLOY_MODE" != "build" || "$REPO_SOURCE" != "existing" ]]; then
|
||||
echo -e " ${BLUE}cd $(pwd)${NC}"
|
||||
fi
|
||||
if [[ "$DEPLOY_MODE" == "build" ]]; then
|
||||
echo -e " ${BLUE}sudo docker compose --profile remote up -d --build${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}A docker-compose.override.yaml has been created alongside${NC}"
|
||||
echo -e "${YELLOW}docker-compose.yaml. Compose auto-loads it, so no -f flag is${NC}"
|
||||
echo -e "${YELLOW}needed — it swaps the prebuilt images for local builds.${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}The first build can take several minutes${NC}"
|
||||
echo -e "${YELLOW}(downloading base images, installing dependencies).${NC}"
|
||||
echo -e "${YELLOW}If you know how to speed this up, we would love a pull request.${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}To rebuild after editing api/ or ui/ code:${NC}"
|
||||
echo ""
|
||||
echo -e " ${BLUE}sudo docker compose --profile remote build && sudo docker compose --profile remote up -d${NC}"
|
||||
else
|
||||
echo -e " ${BLUE}sudo docker compose --profile remote up --pull always${NC}"
|
||||
fi
|
||||
echo ""
|
||||
echo -e "${YELLOW}Your application will be available at:${NC}"
|
||||
echo ""
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue