From 78c5231decdeda36b345c5f99cc846c21afb0a85 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Sun, 9 Feb 2025 21:28:04 +0000 Subject: [PATCH] doc: updated teh documentation to capture the previous pitfalls --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf025da..ac81230 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,13 @@ This is a repo that is used as a template to deploy to Skynet ## Create SSH Key Details to do this can be found here: [wiki](https://wiki.skynet.ie/tutorials/skynet/create_ssh/) -It is recommended to create a new key for just Forgejo Actions. +It is recommended to create a new key for just Forgejo Actions. +**_Do not add a password to the key_**, it will cause the pipeline to fail. -### Add key to kynet account -Add the contents of ``$USERNAME.pub`` (public key) to [your skynet account](https://account.skynet.ie/modify_ssh) +### Add key to Skynet account +Add the contents of ``$USERNAME.pub`` (public key) to [your skynet account](https://account.skynet.ie/modify_ssh) +``[CTRL]+[A]`` and ``[CTRL]+[V]`` will copy/paste everything. +The key must remain in its "armor" and the trailing newline at the end must be preserved. ## Secrets One secret must be added to make this work. @@ -16,6 +19,7 @@ Secrets are found in your repo under ``Settings > Actions > Secrets`` * SSH_KEY * This is your private key that was generated above + * Copy paste it exactly End result should look like this: ![Secrets](resources/Secrets.png)