Skip to content

Commit e2f007c

Browse files
committedJul 10, 2024
Merge branch 'stable'
2 parents 93aafa8 + ee141a6 commit e2f007c

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed
 

‎doc/maintainers/self-hosted_runners.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,34 @@ Occasionally Oracle will turn off the machine because:
2323

2424
## Managing the `stack-github-action3` runner
2525

26-
With the appropriate authority installed on the server, the runner can be
27-
managed remotely using SSH, with command `ssh ubuntu@arm-runner.stackage.org`.
26+
With the appropriate authority installed on the server, a maintainer can manage
27+
the runner remotely using SSH, with command
28+
`ssh ubuntu@arm-runner.stackage.org`.
29+
30+
!!! info
31+
32+
The authority is the addition of the maintainer's SSH public key to the end
33+
of file `~/.ssh/authorized_keys` on the server.
34+
35+
This is best done using [`tmux`](https://github.com/tmux/tmux/wiki), a terminal
36+
multiplexer, as follows:
37+
~~~sh
38+
$ # In a shell, command tmux to create a new session with a single window with a
39+
$ # single pane (a pseudo terminal). The session will be displayed on the screen
40+
$ # by a client:
41+
$ tmux new-session
42+
$ # Send the following command to that pseudo terminal, to connect to the
43+
$ # remote host:
44+
$ ssh ubuntu@arm-runner.stackage.org
45+
$ # In the remote host, change to the actions-runner directory:
46+
$ cd actions-runner
47+
$ # In the remote host, start the runner:
48+
$ ./run.sh
49+
$ # Detach the current client from the session by the key combination of
50+
$ # 'C-b' 'd' (where 'C-b' is CTRL+b). The session will continue to run in the
51+
$ # background:
52+
$ C-b d
53+
~~~
2854

2955
The available disk space can be queried with command `df -h`; the relevant entry
3056
is for filesystem `/dev/sda1`.

0 commit comments

Comments
 (0)
Please sign in to comment.