deploy-prod.yml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  1. name: "[Prod] Deploy"
  2. on:
  3. workflow_dispatch:
  4. inputs:
  5. tag:
  6. description: "Version tag to deploy (e.g. v1.2.39). Leave blank to deploy the newest published release. 'latest' is refused."
  7. required: false
  8. default: ""
  9. jobs:
  10. deploy:
  11. runs-on: [self-hosted, Linux, X64, hetzner]
  12. steps:
  13. - name: Resolve version tag
  14. id: tag
  15. run: |
  16. TAG="${{ inputs.tag }}"
  17. if [ -z "$TAG" ]; then
  18. # Newest published release (drafts are excluded, so publishing the
  19. # release in GitHub is the gate that makes it deployable).
  20. TAG=$(curl -fsSL -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
  21. "https://api.github.com/repos/${{ github.repository }}/releases/latest" \
  22. | grep -m1 '"tag_name"' | cut -d'"' -f4)
  23. echo "Resolved newest published release: $TAG"
  24. fi
  25. if [ -z "$TAG" ] || [ "$TAG" = "latest" ]; then
  26. echo "::error::No deployable version tag ('latest' is refused; rollback needs a named target)."
  27. exit 1
  28. fi
  29. echo "value=$TAG" >> "$GITHUB_OUTPUT"
  30. - name: Log in to GitHub Container Registry
  31. run: echo "${{ secrets.GHCR_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
  32. - name: Create deployment files
  33. env:
  34. VIRTUAL_HOST: ${{ secrets.CLOUD_VIRTUAL_HOST }}
  35. DATABASE_URL: ${{ secrets.CLOUD_DATABASE_URL }}
  36. BETTER_AUTH_SECRET: ${{ secrets.CLOUD_BETTER_AUTH_SECRET }}
  37. APP_URL: ${{ secrets.CLOUD_APP_URL }}
  38. # Plans are sold on torqvoice.com. This secret is the one torqvoice.com
  39. # holds as TORQVOICE_SERVICE_SECRET; the app signs checkout handoffs
  40. # with it and authenticates billing calls with it. The Stripe keys
  41. # themselves live in this app's database and are edited from the
  42. # torqvoice.com admin, so they are no longer passed here.
  43. TORQVOICE_SERVICE_SECRET: ${{ secrets.TORQVOICE_SERVICE_SECRET }}
  44. # Signed by torqvoice.com for APP_URL (scripts/mint-cloud-token.mjs there).
  45. # Without it the app ignores TORQVOICE_MODE=cloud and runs self-hosted.
  46. TORQVOICE_CLOUD_TOKEN: ${{ secrets.CLOUD_TORQVOICE_CLOUD_TOKEN }}
  47. DATA_PATH: ${{ secrets.DATA_PATH }}
  48. POSTHOG_HOST: ${{ secrets.NEXT_PUBLIC_POSTHOG_HOST }}
  49. POSTHOG_KEY: ${{ secrets.NEXT_PUBLIC_POSTHOG_KEY }}
  50. BACKUP_HEARTBEAT_TOKEN: ${{ secrets.BACKUP_HEARTBEAT_TOKEN }}
  51. INTEGRATIONS_ENCRYPTION_KEY: ${{ secrets.CLOUD_INTEGRATIONS_ENCRYPTION_KEY }}
  52. # Customer replies by email (Messages > email channel). The domain SES
  53. # receives mail for, the bucket its receipt rule writes into, the
  54. # region of both, and the topic whose deliveries the webhook accepts.
  55. # All four or none: with any missing the channel stays off and
  56. # customer mail goes out without a reply address, as before.
  57. INBOUND_MAIL_DOMAIN: ${{ secrets.CLOUD_INBOUND_MAIL_DOMAIN }}
  58. INBOUND_MAIL_BUCKET: ${{ secrets.CLOUD_INBOUND_MAIL_BUCKET }}
  59. INBOUND_MAIL_REGION: ${{ secrets.CLOUD_INBOUND_MAIL_REGION }}
  60. INBOUND_MAIL_TOPIC_ARN: ${{ secrets.CLOUD_INBOUND_MAIL_TOPIC_ARN }}
  61. # Backups by Torqvoice: one restic repository per Pro workshop in a bucket of ours.
  62. # Endpoint, bucket, access key, secret key and master key go together, or the schedule
  63. # stays off. The master key derives every repository password: keep it in the DR vault.
  64. # Region is optional and defaults to auto, right for Cloudflare R2; set it for a
  65. # regional bucket anywhere else. The alert email is optional.
  66. PLATFORM_BACKUP_S3_ENDPOINT: ${{ secrets.CLOUD_PLATFORM_BACKUP_S3_ENDPOINT }}
  67. PLATFORM_BACKUP_S3_BUCKET: ${{ secrets.CLOUD_PLATFORM_BACKUP_S3_BUCKET }}
  68. PLATFORM_BACKUP_S3_REGION: ${{ secrets.CLOUD_PLATFORM_BACKUP_S3_REGION }}
  69. PLATFORM_BACKUP_S3_ACCESS_KEY: ${{ secrets.CLOUD_PLATFORM_BACKUP_S3_ACCESS_KEY }}
  70. PLATFORM_BACKUP_S3_SECRET_KEY: ${{ secrets.CLOUD_PLATFORM_BACKUP_S3_SECRET_KEY }}
  71. PLATFORM_BACKUP_MASTER_KEY: ${{ secrets.CLOUD_PLATFORM_BACKUP_MASTER_KEY }}
  72. PLATFORM_BACKUP_ALERT_EMAIL: ${{ secrets.CLOUD_PLATFORM_BACKUP_ALERT_EMAIL }}
  73. # Optional, a repository variable rather than a secret: the largest backup data
  74. # file a restore reads into memory, in MiB (128 unless set, see .env.example).
  75. BACKUP_MAX_DATA_FILE_MB: ${{ vars.CLOUD_BACKUP_MAX_DATA_FILE_MB }}
  76. # Optional. Next encrypts what a server action closes over with a key
  77. # made fresh by every build, so a tab left open across a deploy can
  78. # no longer be read by the new container. A fixed key keeps those tabs
  79. # working. 32 random bytes, base64: `openssl rand -base64 32`. Left
  80. # unset, the build's own key is used, as before.
  81. NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.CLOUD_NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
  82. GOOGLE_INTEGRATION_CLIENT_ID: ${{ secrets.CLOUD_GOOGLE_INTEGRATION_CLIENT_ID }}
  83. GOOGLE_INTEGRATION_CLIENT_SECRET: ${{ secrets.CLOUD_GOOGLE_INTEGRATION_CLIENT_SECRET }}
  84. GOOGLE_AUTH_CLIENT_ID: ${{ secrets.CLOUD_GOOGLE_AUTH_CLIENT_ID }}
  85. GOOGLE_AUTH_CLIENT_SECRET: ${{ secrets.CLOUD_GOOGLE_AUTH_CLIENT_SECRET }}
  86. MICROSOFT_INTEGRATION_CLIENT_ID: ${{ secrets.CLOUD_MICROSOFT_INTEGRATION_CLIENT_ID }}
  87. MICROSOFT_INTEGRATION_CLIENT_SECRET: ${{ secrets.CLOUD_MICROSOFT_INTEGRATION_CLIENT_SECRET }}
  88. ZOOM_INTEGRATION_CLIENT_ID: ${{ secrets.CLOUD_ZOOM_INTEGRATION_CLIENT_ID }}
  89. ZOOM_INTEGRATION_CLIENT_SECRET: ${{ secrets.CLOUD_ZOOM_INTEGRATION_CLIENT_SECRET }}
  90. QUICKBOOKS_INTEGRATION_CLIENT_ID: ${{ secrets.CLOUD_QUICKBOOKS_INTEGRATION_CLIENT_ID }}
  91. QUICKBOOKS_INTEGRATION_CLIENT_SECRET: ${{ secrets.CLOUD_QUICKBOOKS_INTEGRATION_CLIENT_SECRET }}
  92. FIKEN_INTEGRATION_CLIENT_ID: ${{ secrets.CLOUD_FIKEN_INTEGRATION_CLIENT_ID }}
  93. FIKEN_INTEGRATION_CLIENT_SECRET: ${{ secrets.CLOUD_FIKEN_INTEGRATION_CLIENT_SECRET }}
  94. run: |
  95. mkdir -p $HOME/torqvoice-deploy/prod
  96. cd $HOME/torqvoice-deploy/prod
  97. env | grep -E '^(VIRTUAL_HOST|DATA_PATH|DATABASE_URL|BETTER_AUTH_SECRET|APP_URL|TORQVOICE_|POSTHOG_|BACKUP_|INTEGRATIONS_|GOOGLE_INTEGRATION_|GOOGLE_AUTH_|MICROSOFT_INTEGRATION_|ZOOM_INTEGRATION_|QUICKBOOKS_INTEGRATION_|FIKEN_INTEGRATION_|INBOUND_MAIL_|PLATFORM_BACKUP_|NEXT_SERVER_ACTIONS_)' > .env
  98. cat > docker-compose.yml << 'COMPOSE'
  99. networks:
  100. proxy:
  101. external: true
  102. name: proxy
  103. services:
  104. torqvoice-app:
  105. container_name: torqvoice-app
  106. image: ghcr.io/torqvoice/torqvoice:${APP_TAG:-latest}
  107. restart: unless-stopped
  108. volumes:
  109. - ${DATA_PATH}/torqvoice_data:/app/data
  110. expose:
  111. - "3000"
  112. environment:
  113. VIRTUAL_HOST: ${VIRTUAL_HOST}
  114. VIRTUAL_PORT: "3000"
  115. LETSENCRYPT_HOST: ${VIRTUAL_HOST}
  116. DATABASE_URL: ${DATABASE_URL}
  117. BETTER_AUTH_SECRET: ${BETTER_AUTH_SECRET}
  118. NEXT_PUBLIC_APP_URL: ${APP_URL}
  119. TORQVOICE_MODE: cloud
  120. # Production sits behind Cloudflare and the origin only accepts its
  121. # edges, so the visitor address is the one Cloudflare says it is.
  122. # Without this every visitor shares the edge's rate-limit bucket.
  123. TRUST_CF_CONNECTING_IP: "true"
  124. TORQVOICE_SERVICE_SECRET: ${TORQVOICE_SERVICE_SECRET}
  125. TORQVOICE_CLOUD_TOKEN: ${TORQVOICE_CLOUD_TOKEN}
  126. TORQVOICE_COM_URL: https://torqvoice.com
  127. POSTHOG_HOST: ${POSTHOG_HOST}
  128. POSTHOG_KEY: ${POSTHOG_KEY}
  129. BACKUP_HEARTBEAT_TOKEN: ${BACKUP_HEARTBEAT_TOKEN}
  130. INTEGRATIONS_ENCRYPTION_KEY: ${INTEGRATIONS_ENCRYPTION_KEY}
  131. INBOUND_MAIL_DOMAIN: ${INBOUND_MAIL_DOMAIN}
  132. INBOUND_MAIL_BUCKET: ${INBOUND_MAIL_BUCKET}
  133. INBOUND_MAIL_REGION: ${INBOUND_MAIL_REGION}
  134. INBOUND_MAIL_TOPIC_ARN: ${INBOUND_MAIL_TOPIC_ARN}
  135. PLATFORM_BACKUP_S3_ENDPOINT: ${PLATFORM_BACKUP_S3_ENDPOINT}
  136. PLATFORM_BACKUP_S3_BUCKET: ${PLATFORM_BACKUP_S3_BUCKET}
  137. PLATFORM_BACKUP_S3_REGION: ${PLATFORM_BACKUP_S3_REGION}
  138. PLATFORM_BACKUP_S3_ACCESS_KEY: ${PLATFORM_BACKUP_S3_ACCESS_KEY}
  139. PLATFORM_BACKUP_S3_SECRET_KEY: ${PLATFORM_BACKUP_S3_SECRET_KEY}
  140. PLATFORM_BACKUP_MASTER_KEY: ${PLATFORM_BACKUP_MASTER_KEY}
  141. PLATFORM_BACKUP_ALERT_EMAIL: ${PLATFORM_BACKUP_ALERT_EMAIL}
  142. BACKUP_MAX_DATA_FILE_MB: ${BACKUP_MAX_DATA_FILE_MB}
  143. NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${NEXT_SERVER_ACTIONS_ENCRYPTION_KEY}
  144. GOOGLE_INTEGRATION_CLIENT_ID: ${GOOGLE_INTEGRATION_CLIENT_ID}
  145. GOOGLE_INTEGRATION_CLIENT_SECRET: ${GOOGLE_INTEGRATION_CLIENT_SECRET}
  146. GOOGLE_AUTH_CLIENT_ID: ${GOOGLE_AUTH_CLIENT_ID}
  147. GOOGLE_AUTH_CLIENT_SECRET: ${GOOGLE_AUTH_CLIENT_SECRET}
  148. MICROSOFT_INTEGRATION_CLIENT_ID: ${MICROSOFT_INTEGRATION_CLIENT_ID}
  149. MICROSOFT_INTEGRATION_CLIENT_SECRET: ${MICROSOFT_INTEGRATION_CLIENT_SECRET}
  150. ZOOM_INTEGRATION_CLIENT_ID: ${ZOOM_INTEGRATION_CLIENT_ID}
  151. ZOOM_INTEGRATION_CLIENT_SECRET: ${ZOOM_INTEGRATION_CLIENT_SECRET}
  152. QUICKBOOKS_INTEGRATION_CLIENT_ID: ${QUICKBOOKS_INTEGRATION_CLIENT_ID}
  153. QUICKBOOKS_INTEGRATION_CLIENT_SECRET: ${QUICKBOOKS_INTEGRATION_CLIENT_SECRET}
  154. FIKEN_INTEGRATION_CLIENT_ID: ${FIKEN_INTEGRATION_CLIENT_ID}
  155. FIKEN_INTEGRATION_CLIENT_SECRET: ${FIKEN_INTEGRATION_CLIENT_SECRET}
  156. networks:
  157. - proxy
  158. COMPOSE
  159. # Without the cloud token the new container would come up as a
  160. # self-hosted install: one workshop for everybody, branding back on.
  161. # Stop here, before anything is replaced.
  162. if [ -z "$TORQVOICE_CLOUD_TOKEN" ]; then
  163. echo "::error title=Cloud token missing::CLOUD_TORQVOICE_CLOUD_TOKEN is empty. Mint one for $APP_URL with scripts/mint-cloud-token.mjs in the torqvoice.com repo."
  164. exit 1
  165. fi
  166. # The link to torqvoice.com is what the subscription pages hang on. A
  167. # wrong secret or an origin the site does not list only shows up as a
  168. # missing page, so the deploy asks the site itself and says so.
  169. if [ -n "$TORQVOICE_SERVICE_SECRET" ]; then
  170. status=$(curl -sS -o /dev/null -w '%{http_code}' -X POST https://torqvoice.com/api/app/subscription/ping \
  171. -H "Authorization: Bearer $TORQVOICE_SERVICE_SECRET" -H 'Content-Type: application/json' \
  172. -d "{\"appUrl\":\"$APP_URL\"}" || echo 000)
  173. if [ "$status" != "200" ]; then
  174. echo "::warning title=torqvoice.com link not confirmed::ping answered $status. Check TORQVOICE_SERVICE_SECRET on both sides and that $APP_URL is TORQVOICE_APP_URL or TORQVOICE_STAGING_APP_URL on torqvoice.com. The subscription page stays hidden until it is."
  175. else
  176. echo "torqvoice.com link confirmed for $APP_URL"
  177. fi
  178. else
  179. echo "::warning title=torqvoice.com link not configured::TORQVOICE_SERVICE_SECRET is empty, so plans cannot be bought from this deployment."
  180. fi
  181. - name: Ensure data directory permissions
  182. run: |
  183. DATA_DIR="${{ secrets.DATA_PATH }}/torqvoice_data"
  184. mkdir -p "$DATA_DIR"
  185. docker run --rm -v "$DATA_DIR":/data alpine chown -R 1001:1001 /data
  186. - name: Check free disk space
  187. run: |
  188. MIN_GB=5
  189. DOCKER_ROOT=$(docker info --format '{{.DockerRootDir}}' 2>/dev/null || echo /var/lib/docker)
  190. AVAIL_KB=$(df -Pk "$DOCKER_ROOT" | awk 'NR==2 {print $4}')
  191. AVAIL_GB=$(awk "BEGIN {printf \"%.1f\", $AVAIL_KB/1024/1024}")
  192. echo "Free space on $DOCKER_ROOT: ${AVAIL_GB} GB (minimum ${MIN_GB} GB)"
  193. if [ "$AVAIL_KB" -lt $((MIN_GB * 1024 * 1024)) ]; then
  194. echo "::error::Not enough disk space to pull image: ${AVAIL_GB} GB free, need ${MIN_GB} GB. Aborting deploy."
  195. exit 1
  196. fi
  197. - name: Back up production database
  198. env:
  199. DATABASE_URL: ${{ secrets.CLOUD_DATABASE_URL }}
  200. run: |
  201. set -euo pipefail
  202. DB_USER=$(echo "$DATABASE_URL" | sed -E 's|^[^:]+://([^:]+):.*|\1|')
  203. DB_NAME=$(echo "$DATABASE_URL" | sed -E 's|.*/([^/?]+)(\?.*)?$|\1|')
  204. BACKUP_DIR="${{ secrets.DATA_PATH }}/db-backups/$DB_NAME"
  205. # The volume is root-owned and the runner is not root. Binding the
  206. # path into a container makes Docker create it, and the chown hands
  207. # it to the runner so the dump redirect below can write there.
  208. docker run --rm -v "$BACKUP_DIR":/b alpine chown "$(id -u):$(id -g)" /b
  209. # The Postgres data directory lives on this filesystem: filling it
  210. # takes the database down, not just the backup.
  211. MIN_GB=2
  212. AVAIL_KB=$(df -Pk "$BACKUP_DIR" | awk 'NR==2 {print $4}')
  213. if [ "$AVAIL_KB" -lt $((MIN_GB * 1024 * 1024)) ]; then
  214. echo "::error::Only $(awk "BEGIN {printf \"%.1f\", $AVAIL_KB/1024/1024}") GB free where the database lives. Refusing to dump."
  215. exit 1
  216. fi
  217. DUMP="$BACKUP_DIR/${DB_NAME}-$(date +%Y%m%d-%H%M%S)-pre-${{ steps.tag.outputs.value }}.dump"
  218. echo "Dumping $DB_NAME to $DUMP"
  219. docker exec torqvoice-db pg_dump -U "$DB_USER" -d "$DB_NAME" -Fc > "$DUMP"
  220. # A dump nobody can read is worse than no dump. No backup, no deploy.
  221. docker exec -i torqvoice-db pg_restore --list < "$DUMP" > /dev/null
  222. echo "Verified $(du -h "$DUMP" | cut -f1) backup"
  223. # Keep the 10 most recent pre-deploy dumps; hourly dumps in the same
  224. # folder belong to the backup cron and age out there.
  225. ls -t "$BACKUP_DIR"/*-pre-*.dump 2>/dev/null | tail -n +11 | xargs -r rm --
  226. - name: Deploy
  227. run: |
  228. cd $HOME/torqvoice-deploy/prod
  229. APP_TAG=${{ steps.tag.outputs.value }} docker compose up -d --pull always
  230. - name: Health check
  231. run: |
  232. echo "Waiting for prod container to be ready..."
  233. for i in $(seq 1 12); do
  234. STATUS=$(docker inspect --format='{{.State.Status}}' torqvoice-app 2>/dev/null || echo "not found")
  235. if [ "$STATUS" = "running" ]; then
  236. echo "Deployed ${{ steps.tag.outputs.value }}."
  237. exit 0
  238. fi
  239. echo "Status: $STATUS, retrying in 5s..."
  240. sleep 5
  241. done
  242. echo "::error::Container failed to start"
  243. docker logs torqvoice-app --tail 50
  244. exit 1
  245. - name: Prune old images and build cache
  246. run: docker image prune -f && docker builder prune -f