diff --git a/README.md b/README.md index deb3420..fe60d4f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Uses [mkdocs][2] to generate the site. ## Hooks -Run this command to set up the hooks properly so the git information can be stored within the repo +Run this command to set up the hooks properly so teh git information can be stored within the repo ```bash git config --local core.hooksPath .githooks/ diff --git a/mkdocs.yml b/mkdocs.yml index 9894177..35c0d7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,7 @@ theme: features: - search.suggest - search.highlight -# - navigation.expand + - navigation.expand - content.action.view icon: view: material/eye diff --git a/src/procedures/9_email/manage_identities.png b/src/procedures/9_email/manage_identities.png deleted file mode 100644 index f132aef..0000000 --- a/src/procedures/9_email/manage_identities.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c670badb03d5631c768da7df9ed44a514cd7f06e652dcbf09e40976c46127c44 -size 8229 diff --git a/src/procedures/9_email/manage_identity.png b/src/procedures/9_email/manage_identity.png deleted file mode 100644 index 85639a8..0000000 --- a/src/procedures/9_email/manage_identity.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a59c68a209d0c50344ee2447f490a76e860fb7692d3d97665d9e3dff95f7571d -size 23326 diff --git a/src/procedures/9_email/settings.png b/src/procedures/9_email/settings.png deleted file mode 100644 index 90b7d73..0000000 --- a/src/procedures/9_email/settings.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:38490a3906895d67c5e5b0e49d782ff78134c55622890295129a678e9acf5c4e -size 775 diff --git a/src/procedures/9_email/settings_account.png b/src/procedures/9_email/settings_account.png deleted file mode 100644 index fd74281..0000000 --- a/src/procedures/9_email/settings_account.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:515838dc20d92035aacb8ab1458373045a9b2b457aa456e2d0000836f4766470 -size 3172 diff --git a/src/procedures/9_email/settings_account_page.png b/src/procedures/9_email/settings_account_page.png deleted file mode 100644 index d931a97..0000000 --- a/src/procedures/9_email/settings_account_page.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:04cd5ba023a0df4d6b308a9ad089d60224acaf01f13d0b9b7f38a50ed7e6f7ef -size 46294 diff --git a/src/procedures/admin_email.md b/src/procedures/admin_email.md deleted file mode 100644 index f1ccdf0..0000000 --- a/src/procedures/admin_email.md +++ /dev/null @@ -1,51 +0,0 @@ -# Admin - Email - - - -## Alias Setup - - -Well //an// identity, you can have many -Thus its incredibly important -[This talk is incredibly useful for a good overview][1] -[We have SPF, DKIM and DMARK][4] - - -## Aliases - - - -Delivering to //your// mailbox is all good and grand -But what if you want to be someone else? -Such as a service account, for example: ``root[at symbol]skynet.ie`` -Thankfully that is possible (if you are given access) -[We have aliases set up for stuff like that][2] -So anyone in these groups gets mail from these addresses sent to them -These (in our case) get sent to a subfolder in our inboxes -But what if we want to send mail as the service account? -In [Thunderbird][3] it is relatively easy -Sign into your Skynet account on Thunderbird -Select ``Settings`` (bottom right) -![img.png](9_email/settings.png) -Select ``Account Setttings`` -![img_1.png](9_email/settings_account.png) -Select your Skynet email then ``Manage Identities`` -![img_2.png](9_email/settings_account_page.png) -This screen has all your current Identities -Select ``Add`` -![img_3.png](9_email/manage_identities.png) -Add yer ``Name``, ``Email Address`` you want to alias and select ``OK`` -![img_4.png](9_email/manage_identity.png) -In this example I would be able to send mail as ``this_is_a_real_email[at symbol]skynet.ie`` -(if I was actually allowed to do so) - - - -[1]: https://www.youtube.com/watch?v=mrGfahzt-4Q -[2]: https://forgejo.skynet.ie/Skynet/nixos/src/commit/26e715b2f62e406deee5e773ebcc3e3c3d200186/applications/email.nix#L31-L91 -[3]: https://www.thunderbird.net/en-GB/ -[4]: https://forgejo.skynet.ie/Skynet/nixos/src/commit/26e715b2f62e406deee5e773ebcc3e3c3d200186/applications/email.nix#L314-L343 - - - -[original]: https://forgejo.skynet.ie/Computer_Society/presentations_compsoc/src/branch/main/src/slides/skynet/9_email.md \ No newline at end of file diff --git a/src/procedures/admin_modify.md b/src/procedures/admin_modify.md index 544b460..5d3ab5c 100644 --- a/src/procedures/admin_modify.md +++ b/src/procedures/admin_modify.md @@ -1,4 +1,4 @@ -# Admin - Modify +# Change Admins A Skynet Admin is a user with teh highest level of access to the cluster, having been trained up over a year. This guide will cover adding and removing an Admin. diff --git a/src/skynet/services/forgejo.md b/src/skynet/services/forgejo.md index cf33726..caf0dde 100644 --- a/src/skynet/services/forgejo.md +++ b/src/skynet/services/forgejo.md @@ -3,7 +3,7 @@ Forgejo is an online git repo host. Like [Gitlab](./gitlab.md) it is self hostable meaning that Skynet has its own instance of it. -Structure wise it has more in common with Github with the flatter ``owner/repo`` structure as well as being compatible with Github Actions +Structure wise it has more in common with Github with teh flatter ``owner/repo`` structure as well as being compatible with Github Actions Honestly I (@silver) just love the slogan of Forgejo: > Beyond coding. We Forge. diff --git a/src/tutorials/skynet/create_account.md b/src/tutorials/skynet/create_account.md index 2bf1def..16e7b02 100644 --- a/src/tutorials/skynet/create_account.md +++ b/src/tutorials/skynet/create_account.md @@ -8,7 +8,7 @@ 3. Enter the same email used for UL Wolves. * This is the ``Preferred Contact Email`` on your [profile page][profile]. 4. You will get an email to verify your address, follow the link in the email. - * You may need to check the spam folder. + * You may need to check teh spam folder. * It may also take up to 15 min to be delivered. 5. Choose a ``username`` and ``password``. diff --git a/src/tutorials/skynet/create_ssh.md b/src/tutorials/skynet/create_ssh.md index cb06a43..4c144d9 100644 --- a/src/tutorials/skynet/create_ssh.md +++ b/src/tutorials/skynet/create_ssh.md @@ -4,10 +4,7 @@ To be able to gain remote access to the Skynet. ``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver`` -## Windows -If you are using Windows then you should use PowerShell, not ``cmd``. - -## Prep +## Create Key First we set up the ssh folder and create a skynet folder within it for neatness ```bash @@ -15,22 +12,13 @@ mkdir -f -p ~/.ssh/skynet cd ~/.ssh/skynet ``` -## Create Key -Now we will create the ssh key itself. +Now we will create the ssh key itself. +Location: ``$USERNAME``, your skynet username. +Password: Press Enter twice for no password on the key. ```bash ssh-keygen -t ed25519 -C "" ``` - -* ````: this is a comment to yerself about what the key is for - * I often use ``username@host``, ``silver@skynet``. -* Location: ``./$USERNAME``, your skynet username. - * ``./silver`` for example. -* **Password: Press Enter twice for no password on the key.** - -If you are creating this key for a CI/CD pipeline (``user_deploy*``) then adding a password will cause it to fail. - - It will create two files: ``$USERNAME`` and ``$USERNAME.pub`` inside ``~/.ssh/skynet`` ### Linux Only @@ -79,7 +67,7 @@ nano config Or open up in a text editor. ### Windows/Linux -This is what we want to have in the file. +This is what we want to have in teh file. ``` Host *.skynet.ie User $USERNAME @@ -91,7 +79,7 @@ Host *.skynet.ie ## Add key to account -Go to [the modify SSH page](https://account.skynet.ie/modify_ssh) and paste in the contents of ``$USERNAME.pub``. +Go to [the modify SSH page](https://account.skynet.ie/modify_ssh) and paste in teh contents of ``$USERNAME.pub``. You will now be able to SSH into Skynet like so: diff --git a/src/tutorials/skynet/create_website.md b/src/tutorials/skynet/create_website.md index 38e78da..f18f128 100644 --- a/src/tutorials/skynet/create_website.md +++ b/src/tutorials/skynet/create_website.md @@ -1,42 +1,11 @@ # Create your own website on Skynet -One of the services that Skynet provides is access to a Linux server which also has a webserver. -Additionally each member gets their own domain: - -* ``$USERNAME.users.skynet.ie`` - * This is the core web address - * -* ``skynet.ie/~$USERNAME`` - * This is backwards compatible to help avoid link rot - * Redirects to the core address above - * - -## Website -There are two ways to create a website on Skynet, Modern and Manual. -Modern is using Source Control (git), pipelines (CI/CD) and pinch of magic. -Manual gets you hands on with the process. - - -### Skynet Account requirement -No matter if you choose Modern or Manual you will need a Skynet account. -Instructions to do so can be found [on the Create Skynet Account page](./create_account.md). - -### Modern -Modern involves using source control to version your site. -This is then leveraged to automatically deploy to your Skynet account/website. - -The core repo for this is [here][deploy_user], it contains all the required info to get it working. -If this does not suit your needs you can take a look at the [forks which cover different tools][deploy_user_forks]. - -[deploy_user]: https://forgejo.skynet.ie/Skynet/deploy_user -[deploy_user_forks]: https://forgejo.skynet.ie/Skynet/deploy_user/forks - -### Manual -#### Login +## Login Once ye have [logged in](./create_ssh.md) you will be able to create a website on Skynet. +## Website +### Manually -#### Create Files In your home folder follow these commands to create the folder that can be used to host a website ```bash @@ -46,32 +15,12 @@ chmod -R 755 ~/public_html cd ~/public_html ``` -In this directory you can create all the relevant files using ``nano`` or ``vim``. - -```bash -# create/edit index.html usign nano -# this opens up a termial based text editor. -nano index.html -``` - -To exit ``nano`` you need to use ``[ctrl]+[x]`` keys. - -#### Transfer files -If you already have the files locally you can copy them over using ``scp``, although it is recommended to do it graphically. - To transfer files graphically you can use these programs: +* WinSCP +* FileZilla -* [WinSCP][download_winscp] - * Windows -* [FileZilla][download_filezilla] - * Windows - * Mac - * Linux - -[download_winscp]: https://winscp.net -[download_filezilla]: https://filezilla-project.org/download.php?type=client - -Anything put there will be accessible under ``https://$USERNAME.users.skynet.ie``. +Anything put there will be accessible under ``https://$USERNAME.users.skynet.ie``. +For backwards compatability ``https://skynet.ie/~$USERNAME`` will redirect to ``https://$USERNAME.users.skynet.ie``. ## More info There is a slideshow that might be of use to you: \ No newline at end of file