Question 1

How to use webfactory/ssh-agent with multiple private keys?

Accepted Answer

Pass multiple keys in the ssh-private-key input using a YAML block scalar, like listing secrets separated by newlines. The action loads all keys into the ssh-agent, but note that SSH servers may abort after too many wrong keys, so use GitHub deploy key comments for optimization.

Question 2

ssh-agent GitHub Action vs using SSH keys directly in a workflow file?

Accepted Answer

This action is safer and more convenient as it keeps keys in memory via ssh-agent, avoiding disk exposure. Direct key usage often involves writing keys to files, which is less secure and doesn't handle multi-key scenarios or GitHub deploy key mapping automatically.

Question 3

How to forward SSH agent to Docker build in GitHub Actions?

Accepted Answer

After setting up the ssh-agent step, pass --ssh default=${{ env.SSH_AUTH_SOCK }} to docker build or use the ssh key in docker/build-push-action. For multiple deploy keys, you also need to copy Git and SSH config files into the build context, as detailed in the README.

Question 4

Why does my SSH key show 'invalid format' error with this action?

Accepted Answer

This error occurs if the private key isn't in PEM format. Convert it using ssh-keygen -p -f path/to/key -m pem, as mentioned in the README's 'Known Issues and Limitations' section, ensuring no passphrase is set.

Question 5

Does webfactory/ssh-agent work on Windows runners in GitHub Actions?

Accepted Answer

Yes, but the README cautions that Windows support is new and may not be smooth, with limited feedback. You might need additional setup, like configuring Cargo for Rust dependencies, and should test thoroughly in your workflow.

Question 6

How to set up GitHub deploy keys for private dependencies in CI with this action?

Accepted Answer

Generate an SSH key with the repository URL as a comment (e.g., git@github.com:owner/repo.git), add the public key as a deploy key on GitHub, and load the private key via the action. The action uses comments to map keys correctly, avoiding access errors.

Question 7

What if I need SSH keys in multiple jobs in a workflow?

Accepted Answer

You must add the ssh-agent action in each job that requires SSH access, as keys are not shared between jobs. Use the same GitHub secret for consistency, but this increases configuration overhead and potential for duplication.

Setup ssh-agent

What is Setup ssh-agent?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions