diff --git a/.forgejo/workflows/push.yaml b/.forgejo/workflows/push.yaml index 7b82f36..f501f6b 100644 --- a/.forgejo/workflows/push.yaml +++ b/.forgejo/workflows/push.yaml @@ -4,46 +4,25 @@ on: push: branches: - 'main' +# paths: +# - src/**/* jobs: build: runs-on: docker steps: - # Step 1: Checkout the repository + # get the repo first - uses: https://code.forgejo.org/actions/checkout@v4 # Make sure all files are pulled down - uses: https://forgejo.skynet.ie/Skynet/actions/get_lfs@v6 with: repository: ${{ gitea.repository }} ref_name: ${{ gitea.ref_name }} - - # Step 2: Install latest Hugo - - name: Install Hugo - run: | - HUGO_VERSION=$(curl -s https://api.github.com/repos/gohugoio/hugo/releases/latest | grep -Po '"tag_name": "\K[^"]+' | sed 's/^v//') - wget -q https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_Linux-amd64.deb - dpkg -i ./hugo_extended_${HUGO_VERSION}_Linux-amd64.deb - hugo version - - # Step 3: Ensure submodules or themes are initialized (only needed if your using github submodules for theme purposes) - - name: Initialize Submodules - run: git submodule update --init --recursive - - # Step 4: Set the correct URL for skynet - - name: Set the site URL correctly - run: sed -i "s%baseURL.*%baseURL='https://${{ env.GITHUB_REPOSITORY_OWNER }}.users.skynet.ie'%" hugo.toml - - # Step 5: Build the Hugo site - - name: Build Hugo site - env: - HUGO_ENV: production - run: hugo --minify # Reduce resources by minifying content - - # Step 6: Deploy the /public directory to the server + # temp one just to get it "built" - uses: https://forgejo.skynet.ie/Skynet/actions/deploy_user@v6 with: ssh_key: ${{ secrets.SSH_KEY }} username: ${{ env.GITHUB_REPOSITORY_OWNER }} - folder: "public" + folder: "src" # uncomment below if you want to deploy to a subfolder #destination: "subfolder" \ No newline at end of file diff --git a/.gitignore b/.gitignore index dc1bf85..dce8b15 100644 --- a/.gitignore +++ b/.gitignore @@ -26,14 +26,3 @@ test.* # Dealing with Mac users .DS_Store - -################################################### -# Hugo Stuff -################################################### -# Dont commit lockfiles used for building like this -.hugo_build.lock - -# public is generated -/public - -/**/_gen \ No newline at end of file diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 89af1b0..0000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "themes/PaperMod"] - path = themes/PaperMod - url = https://github.com/adityatelange/hugo-PaperMod.git diff --git a/.hugo_build.lock b/.hugo_build.lock deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md index f206aaa..e162fcf 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,55 @@ +# 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. -# Hugo Site Setup Guide +## 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) -## **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) +## 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. -## **2. Install Hugo** -Install Hugo by following the official guide: -🔗 [Hugo Installation Instructions](https://gohugo.io/installation/) +### Do not add a password to the key +Adding a password will cause the pipeline to fail. -### Nix -If you are using Nix or NixOS you can use ``nix develop`` to enable a local shell which contains Hugo. +### 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. ---- +## Use the Template +Now its time to make your own copy of this repo. -## **3. Clone the Repository** -Run the following command to clone the repository: -```sh -git clone +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. -# Update the submodules -git submodule update --init --recursive -``` +## Secrets +One secret must be added to make this work. -Replace `` with the actual repository URL. +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 -## **4. Choose & Configure a Theme** +End result should look like this: +![Secrets](resources/Secrets.png) -### **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/) +## Make changes to ``src`` +**This is only relevant for this repo, the forks may have different ways to modify your site** -**Note:** This project uses **YAML** for configuration, while many Hugo themes use **TOML**. Adjust the settings accordingly. - ---- \ No newline at end of file +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`` \ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md deleted file mode 100644 index c6f3fce..0000000 --- a/archetypes/default.md +++ /dev/null @@ -1,5 +0,0 @@ -+++ -title = '{{ replace .File.ContentBaseName "-" " " | title }}' -date = {{ .Date }} -draft = true -+++ diff --git a/content/posts/my-first-draft.md b/content/posts/my-first-draft.md deleted file mode 100644 index e4706fe..0000000 --- a/content/posts/my-first-draft.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = 'My First Draft' -date = 2025-02-13T13:26:35Z -draft = true -+++ - -This page wont be shown publicly yet \ No newline at end of file diff --git a/content/posts/my-first-post.md b/content/posts/my-first-post.md deleted file mode 100644 index 953254e..0000000 --- a/content/posts/my-first-post.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = 'My First Post' -date = 2025-02-13T13:26:35Z -draft = false -+++ - -Put yer markdown content here \ No newline at end of file diff --git a/content/posts/post-2025-01-01:1.md b/content/posts/post-2025-01-01:1.md deleted file mode 100644 index 4a273da..0000000 --- a/content/posts/post-2025-01-01:1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "My 1st post" -date: 2020-09-15T11:30:03+00:00 -# weight: 1 -# aliases: ["/first"] -tags: ["first"] -author: "Me" -# author: ["Me", "You"] # multiple authors -showToc: true -TocOpen: false -draft: false -hidemeta: false -comments: false -description: "Desc Text." -canonicalURL: "https://canonical.url/to/page" -disableHLJS: true # to disable highlightjs -disableShare: false -disableHLJS: false -hideSummary: false -searchHidden: true -ShowReadingTime: true -ShowBreadCrumbs: true -ShowPostNavLinks: true -ShowWordCount: true -ShowRssButtonInSectionTermList: true -UseHugoToc: true -cover: - image: "" # image path/url - alt: "" # alt text - caption: "" # display caption under cover - relative: false # when using page bundles set this to true - hidden: true # only hide on current single page -editPost: - URL: "https://github.com//content" - Text: "Suggest Changes" # edit text - appendFilePath: true # to append file path to Edit link ---- \ No newline at end of file diff --git a/content/search.md b/content/search.md deleted file mode 100644 index 0650f76..0000000 --- a/content/search.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Search" # in any language you want -layout: "search" # necessary for search -# url: "/archive" -# description: "Description for Search" -summary: "search" -placeholder: "search" ---- \ No newline at end of file diff --git a/flake.lock b/flake.lock deleted file mode 100644 index 5fecbc5..0000000 --- a/flake.lock +++ /dev/null @@ -1,60 +0,0 @@ -{ - "nodes": { - "flake-utils": { - "inputs": { - "systems": "systems" - }, - "locked": { - "lastModified": 1731533236, - "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", - "type": "github" - }, - "original": { - "owner": "numtide", - "repo": "flake-utils", - "type": "github" - } - }, - "nixpkgs": { - "locked": { - "lastModified": 1739214665, - "narHash": "sha256-26L8VAu3/1YRxS8MHgBOyOM8xALdo6N0I04PgorE7UM=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "64e75cd44acf21c7933d61d7721e812eac1b5a0a", - "type": "github" - }, - "original": { - "id": "nixpkgs", - "ref": "nixos-unstable", - "type": "indirect" - } - }, - "root": { - "inputs": { - "flake-utils": "flake-utils", - "nixpkgs": "nixpkgs" - } - }, - "systems": { - "locked": { - "lastModified": 1681028828, - "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", - "owner": "nix-systems", - "repo": "default", - "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", - "type": "github" - }, - "original": { - "owner": "nix-systems", - "repo": "default", - "type": "github" - } - } - }, - "root": "root", - "version": 7 -} diff --git a/flake.nix b/flake.nix deleted file mode 100644 index 88d0e2f..0000000 --- a/flake.nix +++ /dev/null @@ -1,24 +0,0 @@ -{ - inputs = { - nixpkgs.url = "nixpkgs/nixos-unstable"; - - flake-utils.url = "github:numtide/flake-utils"; - }; - - outputs = { - self, - nixpkgs, - ... - } @ inputs: let - pkgs = nixpkgs.legacyPackages.x86_64-linux.pkgs; - in { - devShells.x86_64-linux.default = pkgs.mkShell { - name = "Hugo build env"; - nativeBuildInputs = [ - pkgs.hugo - ]; - buildInputs = []; -# shellHook = ''export EDITOR="${pkgs.nano}/bin/nano --nonewlines"; unset LD_LIBRARY_PATH;''; - }; - }; -} diff --git a/hugo.toml b/hugo.toml deleted file mode 100644 index 4660e00..0000000 --- a/hugo.toml +++ /dev/null @@ -1,4 +0,0 @@ -baseURL = 'https://example.org/' -languageCode = 'en-us' -title = 'My New Hugo Site' -theme = 'PaperMod' diff --git a/hugo.yaml b/hugo.yaml deleted file mode 100644 index 09f585e..0000000 --- a/hugo.yaml +++ /dev/null @@ -1,137 +0,0 @@ -baseURL: "https://examplesite.com/" -title: ExampleSite -paginate: 5 -theme: PaperMod - -enableRobotsTXT: true -buildDrafts: false -buildFuture: false -buildExpired: false - -minify: - disableXML: true - minifyOutput: true - -params: - env: production # to enable google analytics, opengraph, twitter-cards and schema. - title: ExampleSite - description: "ExampleSite description" - keywords: [Blog, Portfolio, PaperMod] - author: Me - # author: ["Me", "You"] # multiple authors - images: [""] - DateFormat: "January 2, 2006" - defaultTheme: auto # dark, light - disableThemeToggle: false - - ShowReadingTime: true - ShowShareButtons: true - ShowPostNavLinks: true - ShowBreadCrumbs: true - ShowCodeCopyButtons: false - ShowWordCount: true - ShowRssButtonInSectionTermList: true - UseHugoToc: true - disableSpecial1stPost: false - disableScrollToTop: false - comments: false - hidemeta: false - hideSummary: false - showtoc: false - tocopen: false - - assets: - # disableHLJS: true # to disable highlight.js - # disableFingerprinting: true - favicon: "" - favicon16x16: "" - favicon32x32: "" - apple_touch_icon: "" - safari_pinned_tab: "" - - label: - text: "Home" - icon: /apple-touch-icon.png - iconHeight: 35 - - # profile-mode - profileMode: - enabled: false # needs to be explicitly set - title: ExampleSite - subtitle: "This is subtitle" - imageUrl: "" - imageWidth: 120 - imageHeight: 120 - imageTitle: my image - buttons: - - name: Posts - url: posts - - name: Tags - url: tags - - # home-info mode - homeInfoParams: - Title: "Hi there \U0001F44B" - Content: Welcome to my blog - - socialIcons: - - name: x - url: "https://x.com/" - - name: stackoverflow - url: "https://stackoverflow.com" - - name: github - url: "https://github.com/" - - analytics: - google: - SiteVerificationTag: "XYZabc" - bing: - SiteVerificationTag: "XYZabc" - yandex: - SiteVerificationTag: "XYZabc" - - cover: - hidden: true # hide everywhere but not in structured data - hiddenInList: true # hide on list pages and home - hiddenInSingle: true # hide on single page - - editPost: - URL: "https://github.com//content" - Text: "Suggest Changes" # edit text - appendFilePath: true # to append file path to Edit link - - # for search - # https://fusejs.io/api/options.html - fuseOpts: - isCaseSensitive: false - shouldSort: true - location: 0 - distance: 1000 - threshold: 0.4 - minMatchCharLength: 0 - limit: 10 # refer: https://www.fusejs.io/api/methods.html#search - keys: ["title", "permalink", "summary", "content"] -menu: - main: - - identifier: categories - name: categories - url: /categories/ - weight: 10 - - identifier: tags - name: tags - url: /tags/ - weight: 20 - - identifier: example - name: example.org - url: https://example.org - weight: 30 -# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma -pygmentsUseClasses: true -markup: - highlight: - noClasses: false - # anchorLineNos: true - # codeFences: true - # guessSyntax: true - # lineNos: true - # style: monokai \ No newline at end of file diff --git a/resources/Secrets.png b/resources/Secrets.png index d555fb2..0adebae 100644 --- a/resources/Secrets.png +++ b/resources/Secrets.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bedff41d5e804577020539b26da95c2034b5f768b08590611975c9f2a6795faf -size 42331 +oid sha256:6d20472644d47f81f27e3221a8d1be7929fe22d2ccabae4294e50d8f68015543 +size 11124 diff --git a/resources/UseThisTemplate.png b/resources/UseThisTemplate.png new file mode 100644 index 0000000..09e1070 --- /dev/null +++ b/resources/UseThisTemplate.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f9bbf26e5207d2df76951dda4bea51d58eaa8a8f1d35554a9370533bd31f3f1 +size 1941 diff --git a/src/index.html b/src/index.html new file mode 100644 index 0000000..8236fdc --- /dev/null +++ b/src/index.html @@ -0,0 +1,12 @@ + + + + + + +
+

Hello World!

+

All hail Skynet!!

+
+ + diff --git a/themes/PaperMod b/themes/PaperMod deleted file mode 160000 index a020be2..0000000 --- a/themes/PaperMod +++ /dev/null @@ -1 +0,0 @@ -Subproject commit a020be2137458dd0a1f4f3a024cd7b076931e9e3