doc: added readme and rough overview
Some checks failed
On_Push / build (push) Failing after 10s
Some checks failed
On_Push / build (push) Failing after 10s
This commit is contained in:
parent
9048bb7322
commit
21dfe24bca
2 changed files with 29 additions and 0 deletions
26
README.md
Normal file
26
README.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# Deploying to Skynet
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Secrets
|
||||||
|
Two secrets must be added to make this work.
|
||||||
|
|
||||||
|
Secrets are found in your repo under ``Settings > Actions > Secrets``
|
||||||
|
|
||||||
|
* USERNAME
|
||||||
|
* This is your skynet username
|
||||||
|
* SSH_KEY
|
||||||
|
* This is your private key that was generated above
|
||||||
|
|
||||||
|
End result should look like this:
|
||||||
|
![Secrets](resources/Secrets.png)
|
||||||
|
|
||||||
|
|
||||||
|
## Make changes to ``src``
|
||||||
|
Make changes to the files in ``src``.
|
||||||
|
Commit and push.
|
||||||
|
If everything was set up fine then your site will soon be live on ``https://$USERNAME.users.skynet.ie``
|
BIN
resources/Secrets.png
(Stored with Git LFS)
Normal file
BIN
resources/Secrets.png
(Stored with Git LFS)
Normal file
Binary file not shown.
Loading…
Reference in a new issue