Files
Evection/scripts/upgrade.sh
T
ksmithandClaude Sonnet 5 21c33e8188 Make the reverse proxy a required, pluggable part of every deployment
gunicorn previously only ever bound to a Unix socket, which assumes the
reverse proxy is nginx running on this same host — it can't be reached by
a proxy on a different machine at all (e.g. Nginx Proxy Manager on its own
box), which is this project's actual deployment target. Switch gunicorn to
listening on a plain TCP address instead, controlled by a new
EVECTION_GUNICORN_BIND setting in .env.

install.sh now asks whether the proxy is local or remote and picks a
sensible bind default either way (127.0.0.1:8000 vs 0.0.0.0:8000, with a
reminder to firewall the port in the remote case), and no longer tries to
automate nginx/certbot itself — docs/install.md's new "Reverse proxy"
section covers both shapes instead, since which proxy and where it runs is
the operator's choice, not something this script should assume or set up.
upgrade.sh's health check now curls the TCP bind instead of the old socket
path.

Also add WhiteNoise so gunicorn serves /static/ itself: the old approach
(nginx aliasing the staticfiles directory on disk) silently breaks the
moment the proxy isn't on this host and can't see this filesystem.
nginx.conf.example's own /static/ alias becomes an optional same-host perf
optimization rather than a requirement.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-31 09:01:46 -06:00

129 lines
5.1 KiB
Bash
Executable File

#!/usr/bin/env bash
# Day-2 deploy/upgrade script, matching the same pattern as the ds-chat
# project's deploy/upgrade.sh: always deploys the latest git tag via a
# detached-HEAD checkout, never whatever the default branch's tip happens
# to be. Run as root, from inside an existing install:
#
# sudo ./scripts/upgrade.sh
#
# Requires scripts/install.sh (or the equivalent manual steps) to have
# been run already, and at least one git tag to exist in the repo (there
# aren't any yet in a fresh clone of this project — cut and push a release
# tag first; this script has nothing to deploy otherwise and says so).
#
# Fails loudly and stops before restarting anything if any step fails —
# the previous deploy keeps running rather than being torn down mid-
# upgrade.
set -euo pipefail
if [ "$(id -u)" -ne 0 ]; then
echo "Run this as root: sudo ./scripts/upgrade.sh" >&2
exit 1
fi
APP_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
EVECTION_HOME="$(dirname "$APP_DIR")"
VENV_DIR="$EVECTION_HOME/venv"
EVECTION_USER="${EVECTION_USER:-evection}"
# $APP_DIR is owned by $EVECTION_USER, but the git steps below run as
# root — without this, git refuses to touch a repo it doesn't own
# ("detected dubious ownership").
git config --global --add safe.directory "$APP_DIR"
if ! id -u "$EVECTION_USER" >/dev/null 2>&1; then
echo "System user '$EVECTION_USER' doesn't exist — is Evection installed?" \
"Run scripts/install.sh first." >&2
exit 1
fi
if [ ! -x "$VENV_DIR/bin/python" ]; then
echo "No virtualenv found at $VENV_DIR — is Evection installed?" \
"Run scripts/install.sh first." >&2
exit 1
fi
if [ ! -d "$APP_DIR/.git" ]; then
echo "$APP_DIR isn't a git checkout, so there's no tag history to deploy from." \
"This script only supports git-based installs." >&2
exit 1
fi
echo "==> Fetching latest release"
cd "$APP_DIR"
# Run git as root (this script already requires it), not as $EVECTION_USER:
# the service user has no reason to have its own git credentials set up,
# and GIT_TERMINAL_PROMPT=0 means a credential problem fails fast instead
# of hanging the upgrade on a silent username/password prompt.
GIT_TERMINAL_PROMPT=0 git fetch --tags --force
LATEST_TAG="$(git tag --sort=-creatordate | head -n1)"
if [ -z "$LATEST_TAG" ]; then
echo "No tags found in this repo — nothing to deploy." \
"Cut and push a release tag first (e.g. git tag v$(date +%Y.%m.%d) && git push --tags)." >&2
exit 1
fi
CURRENT_REF="$(git describe --tags --exact-match 2>/dev/null || echo "none")"
if [ "$CURRENT_REF" = "$LATEST_TAG" ]; then
echo "Already on the latest tag ($LATEST_TAG) — nothing to do."
exit 0
fi
echo "Deploying $LATEST_TAG (currently on: $CURRENT_REF)"
# Detached HEAD, not a branch checkout — this directory only ever runs a
# tagged release, never whatever the default branch's tip happens to be.
git checkout --quiet --detach "$LATEST_TAG"
chown -R "$EVECTION_USER:$EVECTION_USER" "$APP_DIR"
echo "==> Installing updated dependencies"
sudo -u "$EVECTION_USER" -H "$VENV_DIR/bin/pip" install --upgrade "$APP_DIR"
echo "==> Running migrations"
sudo -u "$EVECTION_USER" -H env DJANGO_SETTINGS_MODULE=config.settings.prod \
"$VENV_DIR/bin/python" "$APP_DIR/manage.py" migrate --noinput
echo "==> Collecting static files"
sudo -u "$EVECTION_USER" -H env DJANGO_SETTINGS_MODULE=config.settings.prod \
"$VENV_DIR/bin/python" "$APP_DIR/manage.py" collectstatic --noinput
echo "==> Restarting services"
RESTARTED_ANY=false
for unit in evection-gunicorn evection-celery-worker evection-celery-beat; do
if systemctl list-unit-files "${unit}.service" 2>/dev/null | grep -q "${unit}.service"; then
systemctl restart "$unit"
RESTARTED_ANY=true
fi
done
if [ "$RESTARTED_ANY" = false ]; then
echo "No evection systemd units found to restart — did scripts/install.sh run?" >&2
exit 1
fi
echo "==> Verifying"
sleep 2
# gunicorn always listens on a plain TCP address (EVECTION_GUNICORN_BIND in
# .env, set by scripts/install.sh) rather than a Unix socket, since the
# reverse proxy in front of it may be on a different host entirely — see
# docs/install.md. 0.0.0.0 isn't a valid address to connect *to*, so check
# against localhost in that case; this health check only needs to prove
# gunicorn itself is answering on this host, not reach it the way the
# proxy does.
HEALTH_BIND="$(grep -m1 '^EVECTION_GUNICORN_BIND=' "$APP_DIR/.env" | cut -d= -f2-)"
HEALTH_BIND="${HEALTH_BIND:-127.0.0.1:8000}"
HEALTH_HOST="${HEALTH_BIND%:*}"
HEALTH_PORT="${HEALTH_BIND##*:}"
if [ "$HEALTH_HOST" = "0.0.0.0" ]; then
HEALTH_HOST="127.0.0.1"
fi
if curl -sf "http://$HEALTH_HOST:$HEALTH_PORT/health/" >/dev/null; then
echo "Health check OK"
else
echo "Health check FAILED — check: journalctl -u evection-gunicorn -n 50" >&2
exit 1
fi
systemctl status evection-gunicorn --no-pager -l | head -10
echo
echo "==> Deployed $LATEST_TAG."
echo " If this release changed cached static assets (CSS/JS/icons), bump"
echo " EVECTION_PWA_CACHE_VERSION in $APP_DIR/.env and restart evection-gunicorn"
echo " again so installed PWAs drop their old cache instead of serving stale assets."
echo " journalctl -u evection-gunicorn -f to watch logs."