Skip to content

README.md

Latest commit

 

History

History
110 lines (77 loc) · 2.62 KB

README.md

File metadata and controls

110 lines (77 loc) · 2.62 KB
Raw

Pi auto-deploy

Systemd timer that polls the prod branch every 12 hours and rebuilds the Docker services when there are new commits.

Install

Assumes you've already cloned the repo at /home/pi/zone2 and the user pi is in the docker group. If your username or path differ, edit z2-deploy.service first (the three User= / Group= / WorkingDirectory= / ExecStart= lines).

cd /home/pi/zone2

# 1. Copy units into systemd
sudo cp deploy/z2-deploy.service /etc/systemd/system/
sudo cp deploy/z2-deploy.timer   /etc/systemd/system/

# 2. Load and enable the timer (starts now, runs on every boot)
sudo systemctl daemon-reload
sudo systemctl enable --now z2-deploy.timer

That's it. The timer fires 2 minutes after boot, then every 12 hours.

Usage

Push a change and wait: just git push origin master:prod from your laptop — the Pi picks it up on its next firing.

Force a deploy right now (no need to wait for the timer):

sudo systemctl start z2-deploy.service

Watch live logs:

journalctl -u z2-deploy.service -f

See the timer schedule:

systemctl list-timers z2-deploy.timer

Tuning

Change the poll interval by editing z2-deploy.timer (OnUnitActiveSec= line) — any systemd time spec works (30min, 4h, 1d, etc.). Reload after:

sudo cp deploy/z2-deploy.timer /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl restart z2-deploy.timer

Disable

sudo systemctl disable --now z2-deploy.timer

The units stay in /etc/systemd/system/ but never fire. Remove them with sudo rm /etc/systemd/system/z2-deploy.{service,timer} if you want a clean slate.

Branching workflow

The timer tracks the branch named in scripts/auto-deploy.sh (DEPLOY_BRANCH, default prod). Recommended workflow:

# On your laptop — everyday work
git checkout master
# <edit, commit, push>

# When a change is ready for the Pi:
git push origin master:prod

master stays for WIP; prod is only fast-forwarded when you've vetted the change. You can also override the branch per-run:

DEPLOY_BRANCH=master ./scripts/auto-deploy.sh

Troubleshooting

First run fails with origin/prod does not exist — the branch hasn't been pushed yet. Create it:

git push origin master:prod

docker: permission denied — user pi must be in the docker group:

sudo usermod -aG docker pi
# log out and back in

A build is stuck — check docker compose logs app to see what went wrong. The previous container keeps running while the new one builds, so a failed deploy doesn't take the app down.