Skip to content

Commit 1278aad

Browse files
PMW-41 - docs: add more info about private keys
1 parent 0690df7 commit 1278aad

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ Setup an SSH socket with a private key.
1010
**Required** Path at which to create socket.
1111

1212
#### `key`
13-
**Required** SSH private key
13+
**Required** SSH private key as base64
14+
15+
Base64 encode your key:
16+
17+
openssl base64 -in {PRIVATE_KEY_FILE} -out {OUTPUT_PRIVATE_KEY_FILE}
18+
19+
You can store this in your GitHub Secrets to be referenced in your workflow when using this action.
20+
1421

1522
### Outputs
1623
#### `socket-path`
@@ -23,7 +30,7 @@ Path at which socket was created.
2330
with:
2431
host: github.com
2532
socket-path: /tmp/ssh_agent.sock
26-
key: BASE64_SECRET_KEY
33+
key: {BASE64_SECRET_KEY}
2734

2835
- name: Use SSH socket
2936
run: ls -l "${{ steps.ssh-socket-action.outputs.socket-path }}"

0 commit comments

Comments
 (0)