Skip to content

Commit 7b738b7

Browse files
committed
Document use of tmux
1 parent c975f6c commit 7b738b7

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/maintainers/self-hosted_runners.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,26 @@ Occasionally Oracle will turn off the machine because:
2626
With the appropriate authority installed on the server, the runner can be
2727
managed remotely using SSH, with command `ssh [email protected]`.
2828

29+
This is best done using [`tmux`](https://github.com/tmux/tmux/wiki), a terminal
30+
multiplexer, as follows:
31+
~~~sh
32+
$ # In a shell, command tmux to create a new session with a single window with a
33+
$ # single pane (a pseudo terminal). The session will be displayed on the screen
34+
$ # by a client:
35+
$ tmux new-session
36+
$ # Send the following command to that pseudo terminal, to connect to the
37+
$ # remote host:
38+
39+
$ # In the remote host, change to the actions-runner directory:
40+
$ cd actions-runner
41+
$ # In the remote host, start the runner:
42+
$ ./run.sh
43+
$ # Detach the current client from the session by the key combination of
44+
$ # 'C-b' 'd' (where 'C-b' is CTRL+b). The session will continue to run in the
45+
$ # background:
46+
$ C-b d
47+
~~~
48+
2949
The available disk space can be queried with command `df -h`; the relevant entry
3050
is for filesystem `/dev/sda1`.
3151

0 commit comments

Comments
 (0)