deploy_user/README.md

# Deploying to Skynet
This is a repo that is used as a template to deploy to Skynet.  
It takes all the files in ``src`` and uploads them to your folder on ``skynet.skynet.ie`` and makes them available at ``https://$USERNAME.users.skynet.ie``.  
This makes it easier to deploy your own custom website.

If this is not to your liking you can check out the forks: https://forgejo.skynet.ie/Skynet/deploy_user/forks  
You may find one that is to your liking.  
If you want to add another template please get in contact with the Skynet Team.  

## Create a Skynet Account
To be able to have a website on Skynet you must first have a Skynet account.  
[Instructions on how to create a Skynet Account](https://wiki.skynet.ie/tutorials/skynet/create_account)

## Create SSH Key
Details to do this can be found on our: [wiki](https://wiki.skynet.ie/tutorials/skynet/create_ssh/)  
``Prep`` and ``Create Key`` are the steps to follow in this, the full page covers far more than what ye need.

It is recommended to create a new key for just Forgejo Actions.  

### Do not add a password to the key
Adding a password will cause the pipeline to fail.

### 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.

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)  


## Make changes to ``src``
**This is only relevant for this repo, the forks may have different ways to modify your site**

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``