Private
Public Access
scripts/upgrade.sh now fetches tags and does a detached-HEAD checkout of the latest one (git tag --sort=-creatordate | head -n1), matching the ds-chat project's deploy/upgrade.sh exactly rather than a plain git pull on whatever branch happened to be checked out. Errors clearly if the repo has no tags yet (true for Evection right now — nothing to deploy until a release is tagged and pushed), and no-ops cleanly if already on the latest tag. scripts/install.sh does the same tag pin on first install (falling back to whatever's checked out if no tags exist yet), so the very first deploy is consistent with every upgrade after it. Added a GET /health/ endpoint (apps.core.views.health) that checks DB connectivity and is exempt from the first-run setup redirect, for the upgrade script's post-restart verification (curled over the gunicorn unix socket, same as ds-chat's curl-based check) and for any external uptime monitor. While wiring the setup-wizard exemption for /health/, found that SetupWizardMiddleware._a_user_exists's reset fixture was scoped only to apps/accounts/tests.py, so a test anywhere else that creates a user and makes a request could leak a stale "a user exists" into later test files with no reset — confirmed this concretely by temporarily breaking the new exemption and watching the "works before setup" test still pass purely from accounts/tests.py leaving the module-order-adjacent apps/articles tests to poison the shared class attribute. Moved the fixture to a new top-level conftest.py so it's autouse across every test file, which also makes the new health-check test meaningful regardless of run order. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
202 lines
7.7 KiB
Bash
Executable File
202 lines
7.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Automates docs/install.md's manual steps: system user, virtualenv, .env,
|
|
# migrate/collectstatic, systemd units, and (optionally) nginx + TLS.
|
|
#
|
|
# Run as root, from inside the checkout you want to serve:
|
|
# sudo ./scripts/install.sh
|
|
#
|
|
# Safe to re-run: it skips steps that are already done (existing user,
|
|
# existing venv, existing .env) rather than redoing or overwriting them.
|
|
#
|
|
# Non-interactive use (e.g. scripted provisioning) — set these before
|
|
# running, and the script won't prompt:
|
|
# EVECTION_ALLOWED_HOSTS, EVECTION_DATABASE_URL, EVECTION_REDIS_URL,
|
|
# EVECTION_USER (defaults to "evection")
|
|
|
|
set -euo pipefail
|
|
|
|
if [ "$(id -u)" -ne 0 ]; then
|
|
echo "Run this as root: sudo ./scripts/install.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}"
|
|
PYTHON_BIN="${PYTHON_BIN:-python3}"
|
|
|
|
echo "==> Installing Evection"
|
|
echo " App directory: $APP_DIR"
|
|
echo " Service user: $EVECTION_USER"
|
|
echo " Virtualenv: $VENV_DIR"
|
|
echo
|
|
|
|
# --- 1. Prerequisites -------------------------------------------------
|
|
|
|
if ! command -v "$PYTHON_BIN" >/dev/null 2>&1; then
|
|
echo "'$PYTHON_BIN' not found. Install Python 3.11+ first." >&2
|
|
exit 1
|
|
fi
|
|
PY_VERSION="$("$PYTHON_BIN" -c 'import sys; print("%d.%d" % sys.version_info[:2])')"
|
|
PY_MAJOR="${PY_VERSION%%.*}"
|
|
PY_MINOR="${PY_VERSION##*.}"
|
|
if [ "$PY_MAJOR" -lt 3 ] || { [ "$PY_MAJOR" -eq 3 ] && [ "$PY_MINOR" -lt 11 ]; }; then
|
|
echo "Python $PY_VERSION found, but Evection needs 3.11 or newer." >&2
|
|
exit 1
|
|
fi
|
|
|
|
for bin in redis-cli nginx; do
|
|
if ! command -v "$bin" >/dev/null 2>&1; then
|
|
echo "Warning: '$bin' not found on PATH. Install it before going live" \
|
|
"(see docs/install.md's prerequisites section: apt install redis-server nginx)." >&2
|
|
fi
|
|
done
|
|
|
|
# --- 2. System user -----------------------------------------------------
|
|
|
|
if ! id -u "$EVECTION_USER" >/dev/null 2>&1; then
|
|
echo "==> Creating system user '$EVECTION_USER'"
|
|
adduser --system --group --home "$EVECTION_HOME" "$EVECTION_USER"
|
|
else
|
|
echo "==> System user '$EVECTION_USER' already exists"
|
|
fi
|
|
chown -R "$EVECTION_USER:$EVECTION_USER" "$APP_DIR"
|
|
|
|
# --- 2b. Pin to the latest release tag (if any exist) ----------------
|
|
|
|
if [ -d "$APP_DIR/.git" ]; then
|
|
sudo -u "$EVECTION_USER" -H git -C "$APP_DIR" fetch --tags --force || true
|
|
LATEST_TAG="$(sudo -u "$EVECTION_USER" -H git -C "$APP_DIR" tag --sort=-creatordate | head -n1)"
|
|
if [ -n "$LATEST_TAG" ]; then
|
|
echo "==> Checking out latest release: $LATEST_TAG"
|
|
# Detached HEAD, not a branch checkout — matches scripts/upgrade.sh,
|
|
# which only ever deploys a tagged release, never a branch tip.
|
|
sudo -u "$EVECTION_USER" -H git -C "$APP_DIR" checkout --quiet --detach "$LATEST_TAG"
|
|
else
|
|
echo "==> No release tags found yet — staying on whatever's currently checked out."
|
|
fi
|
|
fi
|
|
|
|
# --- 3. Virtualenv + install ---------------------------------------------
|
|
|
|
if [ ! -d "$VENV_DIR" ]; then
|
|
echo "==> Creating virtualenv at $VENV_DIR"
|
|
sudo -u "$EVECTION_USER" -H "$PYTHON_BIN" -m venv "$VENV_DIR"
|
|
fi
|
|
echo "==> Installing Evection and its dependencies"
|
|
sudo -u "$EVECTION_USER" -H "$VENV_DIR/bin/pip" install --upgrade pip
|
|
sudo -u "$EVECTION_USER" -H "$VENV_DIR/bin/pip" install "$APP_DIR"
|
|
|
|
# --- 4. .env --------------------------------------------------------------
|
|
|
|
ENV_FILE="$APP_DIR/.env"
|
|
if [ ! -f "$ENV_FILE" ]; then
|
|
echo "==> Creating $ENV_FILE"
|
|
SECRET_KEY="$("$VENV_DIR/bin/python" -c 'import secrets; print(secrets.token_urlsafe(50))')"
|
|
|
|
ALLOWED_HOSTS="${EVECTION_ALLOWED_HOSTS:-}"
|
|
if [ -z "$ALLOWED_HOSTS" ] && [ -t 0 ]; then
|
|
read -rp "Domain name(s) this instance will be served from (comma-separated) [localhost]: " ALLOWED_HOSTS
|
|
fi
|
|
ALLOWED_HOSTS="${ALLOWED_HOSTS:-localhost}"
|
|
|
|
DATABASE_URL="${EVECTION_DATABASE_URL:-}"
|
|
if [ -z "$DATABASE_URL" ] && [ -t 0 ]; then
|
|
read -rp "Use PostgreSQL instead of SQLite? [y/N]: " USE_PG
|
|
if [[ "${USE_PG:-}" =~ ^[Yy]$ ]]; then
|
|
read -rp "Postgres DATABASE_URL (postgres://user:pass@host:5432/dbname): " DATABASE_URL
|
|
fi
|
|
fi
|
|
DATABASE_URL="${DATABASE_URL:-sqlite:///$APP_DIR/db.sqlite3}"
|
|
|
|
cat > "$ENV_FILE" <<EOF
|
|
SECRET_KEY=$SECRET_KEY
|
|
DEBUG=False
|
|
ALLOWED_HOSTS=$ALLOWED_HOSTS
|
|
DATABASE_URL=$DATABASE_URL
|
|
REDIS_URL=${EVECTION_REDIS_URL:-redis://localhost:6379/0}
|
|
EVECTION_SIGNUP_ENABLED=False
|
|
EVECTION_MIN_FETCH_INTERVAL_MINUTES=15
|
|
EVECTION_PWA_CACHE_VERSION=v1
|
|
EOF
|
|
chown "$EVECTION_USER:$EVECTION_USER" "$ENV_FILE"
|
|
chmod 600 "$ENV_FILE"
|
|
else
|
|
echo "==> $ENV_FILE already exists — leaving it alone"
|
|
fi
|
|
|
|
# --- 5. Migrate + static files --------------------------------------------
|
|
|
|
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
|
|
|
|
# --- 6. systemd units -------------------------------------------------
|
|
|
|
echo "==> Installing systemd units"
|
|
for unit in evection-gunicorn evection-celery-worker evection-celery-beat; do
|
|
sed -e "s#/opt/evection#$EVECTION_HOME#g" \
|
|
-e "s/User=evection/User=$EVECTION_USER/" \
|
|
-e "s/Group=evection/Group=$EVECTION_USER/" \
|
|
"$APP_DIR/docs/deploy/${unit}.service" > "/etc/systemd/system/${unit}.service"
|
|
done
|
|
systemctl daemon-reload
|
|
systemctl enable --now evection-gunicorn evection-celery-worker evection-celery-beat
|
|
|
|
echo
|
|
echo "==> Services installed. Checking status..."
|
|
systemctl --no-pager status evection-gunicorn evection-celery-worker evection-celery-beat \
|
|
|| echo "One or more services didn't start cleanly — see 'journalctl -u evection-gunicorn' etc." >&2
|
|
|
|
# --- 7. nginx (optional) ---------------------------------------------------
|
|
|
|
SET_UP_NGINX="${EVECTION_SETUP_NGINX:-}"
|
|
if [ -z "$SET_UP_NGINX" ] && [ -t 0 ]; then
|
|
echo
|
|
read -rp "Set up nginx and an HTTPS certificate now? [y/N]: " SET_UP_NGINX
|
|
fi
|
|
|
|
if [[ "${SET_UP_NGINX:-}" =~ ^[Yy]$ ]]; then
|
|
if ! command -v nginx >/dev/null 2>&1; then
|
|
echo "nginx isn't installed — install it first (apt install nginx), then" \
|
|
"run docs/install.md's nginx section manually." >&2
|
|
else
|
|
DOMAIN="${EVECTION_DOMAIN:-}"
|
|
if [ -z "$DOMAIN" ] && [ -t 0 ]; then
|
|
read -rp "Domain name for nginx/TLS (must match a hostname in ALLOWED_HOSTS): " DOMAIN
|
|
fi
|
|
if [ -z "$DOMAIN" ]; then
|
|
echo "No domain given — skipping nginx setup. Run docs/install.md's nginx section manually." >&2
|
|
else
|
|
sed -e "s/your-domain.example/$DOMAIN/g" \
|
|
-e "s#/opt/evection#$EVECTION_HOME#g" \
|
|
"$APP_DIR/docs/deploy/nginx.conf.example" > "/etc/nginx/sites-available/evection"
|
|
ln -sf /etc/nginx/sites-available/evection /etc/nginx/sites-enabled/evection
|
|
if nginx -t; then
|
|
systemctl reload nginx
|
|
echo "==> nginx configured for $DOMAIN (HTTP only so far)"
|
|
if command -v certbot >/dev/null 2>&1; then
|
|
certbot --nginx -d "$DOMAIN" || echo "certbot failed — run it manually: certbot --nginx -d $DOMAIN" >&2
|
|
else
|
|
echo "certbot isn't installed. Install it and run:" \
|
|
"apt install certbot python3-certbot-nginx && certbot --nginx -d $DOMAIN" >&2
|
|
fi
|
|
else
|
|
echo "nginx config test failed — not enabling it. Check /etc/nginx/sites-available/evection." >&2
|
|
fi
|
|
fi
|
|
fi
|
|
else
|
|
echo "==> Skipping nginx — see docs/install.md step 7 to set it up yourself."
|
|
fi
|
|
|
|
echo
|
|
echo "==> Done."
|
|
echo " Visit the site (once nginx/TLS is in place) — the setup wizard creates your admin account."
|
|
echo " To upgrade later: sudo ./scripts/upgrade.sh"
|