Skynet/deploy_user_hugo
Template
7
0
Fork 1
forked from Skynet/deploy_user
Code Pull requests Activity

read me

Browse source
This commit is contained in:
PeaceNira 2025-02-12 17:54:06 +00:00
parent 4007181554
commit e50075b542
1 changed files with 31 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -1,34 +1,40 @@
# Deploying to Skynet
This is a repo that is used as a template to deploy to Skynet
## 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 here: [wiki](https://wiki.skynet.ie/tutorials/skynet/create_ssh/)
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.
# Hugo Site Setup Guide
### 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.
## **1. Set Up Remote Keys**
Follow the steps in the link below to configure your remote keys:
🔗 [Remote Key Setup Instructions](https://forgejo.skynet.ie/Skynet/deploy_user)
## Secrets
One secret must be added to make this work.
---
Secrets are found in your repo under ``Settings > Actions > Secrets``
## **2. Install Hugo**
Install Hugo by following the official guide:
🔗 [Hugo Installation Instructions](https://gohugo.io/installation/)
* 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)
## **3. Clone the Repository**
Run the following command to clone the repository:
```sh
git clone <repo>
```
Replace `<repo>` with the actual repository URL.
## 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``
---
## **4. Choose & Configure a Theme**
### **If you want to continue using PaperMod**
You can find customization and usage details here:
🔗 [PaperMod Wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/)
### **If you want to switch themes**
Browse other Hugo themes here:
🔗 [Hugo Themes](https://themes.gohugo.io/)
**Note:** This project uses **YAML** for configuration, while many Hugo themes use **TOML**. Adjust the settings accordingly.
---