appleboy/ssh-action
Ssh Action
This is a GitHub Action that executes shell commands on remote servers over SSH as part of a CI/CD pipeline. It supports authentication using passwords, private keys, or private keys with passphrases, and can verify the SHA256 fingerprint of the remote host's public key before connecting to prevent man-in-the-middle attacks.
The action can connect to multiple remote hosts in a single workflow step, optionally executing commands synchronously across all of them. It also supports routing SSH connections through an intermediate jump host to reach target servers in restricted networks. Environment variables from the CI runner can be injected into the remote shell session, and the standard output of remote commands can be captured and stored as an action output variable for use in later workflow steps.
The documentation covers setup, authentication methods, proxy routing, multi-host execution, environment variable injection, and command output capture.
Features
- GitHub Actions - Executes remote SSH commands with password, key, or passphrase authentication in CI pipelines.
- CI/CD Automation - Automates deployment tasks by executing remote commands as part of a continuous integration workflow.
- Webhook-Triggered SSH Commands - Executes shell commands on remote servers over SSH from within a GitHub Actions workflow.
- Remote Command Execution - Runs shell commands on remote servers over SSH and streams output back to the CI runner.
- Authenticated SSH Connections - Establishes authenticated SSH connections with host key verification and proxy/jump host support.
- SSH Private Key Authentications - Authenticates to remote hosts using password, private key, or private key with passphrase for secure connections.
- Password and Passphrase Authentications - Authenticates to remote hosts using passwords, private keys, or passphrase-protected keys for secure connections.
- Variable Output Capture - Captures remote command output into a variable for reuse in subsequent workflow steps.
- Multi-Host Parallel Executions - Connects to multiple remote hosts simultaneously and executes commands across all of them in one step.
- Multi-Host SSH Orchestrations - Executes commands across multiple remote hosts simultaneously from a single workflow step.
- Multi-Host SSH Runners - Connects to multiple remote hosts simultaneously and executes commands across all of them in one step.
- Multi-Host Remote Executions - Connects to several remote hosts in a single workflow step, optionally executing commands synchronously across all of them.
- SSH Proxy Connections - Routes SSH connections through an intermediate proxy server to reach a target host in a restricted network.
- SSH Proxy Jump Routings - Routes SSH connections through an intermediate jump host to reach target servers in restricted networks.
- CI/CD Jump Host Connectors - Routes SSH connections through an intermediate jump host to reach target servers in restricted networks.
- SSH Host Fingerprint Verifications - Verifies the SHA256 fingerprint of the remote host's public key before connecting to prevent man-in-the-middle attacks.
- SHA256 Fingerprint Verifications - Verifies remote host SHA256 fingerprints to prevent man-in-the-middle attacks during SSH connections.
- Environment Variable Passes - Sends selected or all CI runner environment variables to remote shell sessions for use in commands.
- Environment Variable Injectors - Passes workflow or custom environment variables into remote SSH sessions for use in commands.
- Environment Variable Injection - Injects CI runner environment variables into remote SSH sessions for use in commands.
- Command Output Streamers - Saves remote command standard output as an action output variable for downstream workflow steps.
- Deployment Automation - Executes remote commands via SSH.
