7
0
Fork 1
forked from Skynet/deploy_user

Compare commits

...
Sign in to create a new pull request.

2 commits
main ... main

3 changed files with 30 additions and 6 deletions

View file

@ -1,20 +1,39 @@
# Deploying to Skynet # Deploying to Skynet
This is a repo that is used as a template to deploy 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 ## Create a Skynet Account
To be able to have a website on Skynet you must first have 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) [Instructions on how to create a Skynet Account](https://wiki.skynet.ie/tutorials/skynet/create_account)
## Create SSH Key ## Create SSH Key
Details to do this can be found here: [wiki](https://wiki.skynet.ie/tutorials/skynet/create_ssh/) 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. 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.
### Do not add a password to the key
Adding a password will cause the pipeline to fail.
### Add key to Skynet account ### Add key to Skynet account
Add the contents of ``$USERNAME.pub`` (public key) to [your skynet account](https://account.skynet.ie/modify_ssh) 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. ``[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. The key must remain in its "armor" and the trailing newline at the end must be preserved.
## Use the Template
Now its time to make your own copy of this repo.
1. At the top of this page you will find this button:
![img.png](resources/UseThisTemplate.png)
2. ``Repository name``: This is what you want to name your repo
3. ``Template items``: Make sure ``Git content (Default branch)`` is ticked.
4. Press the ``Create Repository`` button.
## Secrets ## Secrets
One secret must be added to make this work. One secret must be added to make this work.
@ -22,13 +41,15 @@ Secrets are found in your repo under ``Settings > Actions > Secrets``
* SSH_KEY * SSH_KEY
* This is your private key that was generated above * This is your private key that was generated above
* Copy paste it exactly * Copy & paste it exactly
End result should look like this: End result should look like this:
![Secrets](resources/Secrets.png) ![Secrets](resources/Secrets.png)
## Make changes to ``src`` ## 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``. Make changes to the files in ``src``.
Commit and push. Commit and push.
If everything was set up fine then your site will soon be live on ``https://$USERNAME.users.skynet.ie`` 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)

Binary file not shown.

BIN
resources/UseThisTemplate.png (Stored with Git LFS) Normal file

Binary file not shown.