aboutsummaryrefslogtreecommitdiffstats
path: root/builds.sr.ht/build-ssh.md
diff options
context:
space:
mode:
Diffstat (limited to 'builds.sr.ht/build-ssh.md')
-rw-r--r--builds.sr.ht/build-ssh.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/builds.sr.ht/build-ssh.md b/builds.sr.ht/build-ssh.md
new file mode 100644
index 0000000..f1b85f6
--- /dev/null
+++ b/builds.sr.ht/build-ssh.md
@@ -0,0 +1,23 @@
+---
+title: SSH access to build VMs
+---
+
+You can interact directly with your builds by connecting to the runner over SSH.
+This is helpful for troubleshooting your manifests, or just getting a quick
+temporary environment to test something in.
+
+When a build fails, the VM stays alive for an extra ten minutes, and you'll be
+presented with instructions on how to connect to the runner via SSH, e.g.:
+
+```
+$ ssh -t builds@azusa.runners.sr.ht connect 81809
+Connected to build job #81809 (failed):
+https://builds.sr.ht/jobs/~sircmpwn/81809
+Your VM will be terminated 4 hours from now, or when you log out.
+
+bash-5.0 $
+```
+
+In addition to connecting to failed builds over SSH, you can add `shell: true`
+to your [manifest](manifest.md) to always enable SSH access. Then, you'll be
+able to interact with your build as it runs.