mxschmitt/Debugging with tmate

Debug your GitHub Actions Environment interactively by using SSH or a Web shell

Trust Signals

name	description	required	default
sudo	If apt should be executed with sudo or without	no	auto
install-dependencies	Whether or not to install dependencies for tmate on linux (openssh-client, xz-utils)	no	true
limit-access-to-actor	Whether to authorize only the public SSH keys of the user triggering the workflow (defaults to true if the GitHub profile of the user has a public SSH key)	no	auto
detached	In detached mode, the workflow job will continue while the tmate session is active	no	false
connect-timeout-seconds	How long in seconds to wait for a connection to be established	no	600
tmate-server-host	The hostname for your tmate server (e.g. ssh.example.org)	no	""
tmate-server-port	The port for your tmate server (e.g. 2222)	no	""
tmate-server-rsa-fingerprint	The RSA fingerprint for your tmate server	no	""
tmate-server-ed25519-fingerprint	The ed25519 fingerprint for your tmate server	no	""
msys2-location	The root of the MSYS2 installation (on Windows runners)	no	C:\msys64
github-token	Personal access token (PAT) used to call into GitHub's REST API. We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)	—	${{ github.token }}

name	description
ssh-command	The SSH command to connect to the tmate session (only set when detached mode is enabled)
ssh-address	The raw SSH address without the "ssh" prefix (only set when detached mode is enabled)
web-url	The web URL to connect to the tmate session (only set when detached mode is enabled and web URL is available)