Compare commits

..

34 commits

Author SHA1 Message Date
85a4811735
feat: added start for how to do admin emails 2025-04-24 04:45:40 +01:00
80f1efabb3
feat: the subsections are getting so long now that there is a lot of scrolling 2025-04-24 04:45:40 +01:00
00f334fde4
doc: how to use topdesk as a skynet admin 2025-04-24 04:45:40 +01:00
357b67321d
doc: add section on voice chat and discord intergration 2025-04-24 04:45:40 +01:00
0e42295f5b
doc: added documentation about creating and managing the minecraft servers 2025-04-24 04:45:40 +01:00
59b80218a0
fix: typo 2025-04-24 04:45:40 +01:00
83a26f7f91
docs: Give Proxmox its own page 2025-04-24 04:45:40 +01:00
efa19cfd96
docs: added section on renewing `ulcompsoc.ie` 2025-04-24 04:45:40 +01:00
27facd7920
fmt: move the procedures up a layer 2025-04-24 04:45:40 +01:00
765d6d3f48
doc: information on vaultwarden 2025-04-24 04:45:40 +01:00
48821a414f
doc: added how to find information on updating proxmox 2025-04-24 04:45:40 +01:00
1050c1d8b0
doc: added page on how to add/remove admins 2025-04-24 04:45:40 +01:00
b3ce7c30f4
doc: added procedure to modify committee members 2025-04-24 04:45:40 +01:00
0dbea49129
doc: new topics to cover 2025-04-24 04:45:40 +01:00
3c03d6ae7a
doc: add how to update Nixos based servers 2025-04-24 04:45:40 +01:00
c6f2f62b09
doc: add about how to verify alumni 2025-04-24 04:45:40 +01:00
eaa30e38fd
doc: planned documentation 2025-04-24 04:45:40 +01:00
f3e6d86211
fmt: rename 2025-04-24 04:45:39 +01:00
ececefd9bf
doc: added segments on how to deploy the config 2025-04-24 04:45:39 +01:00
c4631434d6
feat: login to teh server step completed 2025-04-24 04:45:39 +01:00
78c766db90
fmt: little bit of re-organisation 2025-04-24 04:45:39 +01:00
3a32d0936e
doc: added details on how to actually set up the container 2025-04-24 04:45:39 +01:00
9ae1201b1b
feat: abandon the use of the git information in the repo itself 2025-04-24 04:45:39 +01:00
6ba9f59e78
feat: new section for procedures
Got started on how to init a new server
2025-04-24 04:45:39 +01:00
1df4c0bcd3 Merge pull request 'Teh to The' (#33) from generically/wiki:main into main
All checks were successful
Build / build (push) Successful in 9s
Build / deploy (push) Successful in 9s
Reviewed-on: #33
2025-02-15 00:45:35 +00:00
cb1399424e Update src/assets/highlight.min.js 2025-02-15 00:16:33 +00:00
72dcdb1203 changed all occurances of teh to the 2025-02-15 00:13:43 +00:00
ad79fb617d
doc: improved documentation for ssh keys
All checks were successful
Build / build (push) Successful in 12s
Build / deploy (push) Successful in 9s
2025-02-13 17:58:56 +00:00
b6f4f3b1ba
doc: updated documentation
All checks were successful
Build / build (push) Successful in 16s
Build / deploy (push) Successful in 9s
2025-02-12 15:08:36 +00:00
b2c134d950
fix: formatting3
All checks were successful
Build / build (push) Successful in 10s
Build / deploy (push) Successful in 9s
2025-02-10 00:08:58 +00:00
b4d202739e
fix: formatting2
All checks were successful
Build / build (push) Successful in 14s
Build / deploy (push) Successful in 10s
2025-02-09 23:50:15 +00:00
94a37acd12
fix: formatting
Some checks are pending
Build / build (push) Waiting to run
Build / deploy (push) Blocked by required conditions
2025-02-09 23:49:58 +00:00
96822e7b2f
fix: make sure folks know that adding a password to a ssh key will cause CI/CD to fail
All checks were successful
Build / build (push) Successful in 14s
Build / deploy (push) Successful in 10s
2025-02-09 21:21:56 +00:00
347c979b35
feat: updated teh documentation on how to do the websites 2025-02-09 21:21:56 +00:00
13 changed files with 148 additions and 19 deletions

View file

@ -10,7 +10,7 @@ Uses [mkdocs][2] to generate the site.
## Hooks ## Hooks
Run this command to set up the hooks properly so teh git information can be stored within the repo Run this command to set up the hooks properly so the git information can be stored within the repo
```bash ```bash
git config --local core.hooksPath .githooks/ git config --local core.hooksPath .githooks/

View file

@ -19,7 +19,7 @@ theme:
features: features:
- search.suggest - search.suggest
- search.highlight - search.highlight
- navigation.expand # - navigation.expand
- content.action.view - content.action.view
icon: icon:
view: material/eye view: material/eye

BIN
src/procedures/9_email/manage_identities.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
src/procedures/9_email/manage_identity.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
src/procedures/9_email/settings.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
src/procedures/9_email/settings_account.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
src/procedures/9_email/settings_account_page.png (Stored with Git LFS) Normal file

Binary file not shown.

View file

@ -0,0 +1,51 @@
# 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

View file

@ -1,4 +1,4 @@
# Change Admins # Admin - Modify
A Skynet Admin is a user with teh highest level of access to the cluster, having been trained up over a year. 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. This guide will cover adding and removing an Admin.

View file

@ -3,7 +3,7 @@
Forgejo is an online git repo host. Forgejo is an online git repo host.
Like [Gitlab](./gitlab.md) it is self hostable meaning that Skynet has its own instance of it. 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 teh flatter ``owner/repo`` structure as well as being compatible with Github Actions Structure wise it has more in common with Github with the flatter ``owner/repo`` structure as well as being compatible with Github Actions
Honestly I (@silver) just love the slogan of Forgejo: Honestly I (@silver) just love the slogan of Forgejo:
> Beyond coding. We Forge. > Beyond coding. We Forge.

View file

@ -8,7 +8,7 @@
3. Enter the same email used for UL Wolves. 3. Enter the same email used for UL Wolves.
* This is the ``Preferred Contact Email`` on your [profile page][profile]. * 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. 4. You will get an email to verify your address, follow the link in the email.
* You may need to check teh spam folder. * You may need to check the spam folder.
* It may also take up to 15 min to be delivered. * It may also take up to 15 min to be delivered.
5. Choose a ``username`` and ``password``. 5. Choose a ``username`` and ``password``.

View file

@ -4,7 +4,10 @@ To be able to gain remote access to the Skynet.
``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver`` ``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver``
## Create Key ## Windows
If you are using Windows then you should use PowerShell, not ``cmd``.
## Prep
First we set up the ssh folder and create a skynet folder within it for neatness First we set up the ssh folder and create a skynet folder within it for neatness
```bash ```bash
@ -12,13 +15,22 @@ mkdir -f -p ~/.ssh/skynet
cd ~/.ssh/skynet cd ~/.ssh/skynet
``` ```
Now we will create the ssh key itself. ## Create Key
Location: ``$USERNAME``, your skynet username. Now we will create the ssh key itself.
Password: Press Enter twice for no password on the key.
```bash ```bash
ssh-keygen -t ed25519 -C "<comment>" ssh-keygen -t ed25519 -C "<comment>"
``` ```
* ``<comment>``: 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`` It will create two files: ``$USERNAME`` and ``$USERNAME.pub`` inside ``~/.ssh/skynet``
### Linux Only ### Linux Only
@ -67,7 +79,7 @@ nano config
Or open up in a text editor. Or open up in a text editor.
### Windows/Linux ### Windows/Linux
This is what we want to have in teh file. This is what we want to have in the file.
``` ```
Host *.skynet.ie Host *.skynet.ie
User $USERNAME User $USERNAME
@ -79,7 +91,7 @@ Host *.skynet.ie
## Add key to account ## Add key to account
Go to [the modify SSH page](https://account.skynet.ie/modify_ssh) and paste in teh contents of ``$USERNAME.pub``. Go to [the modify SSH page](https://account.skynet.ie/modify_ssh) and paste in the contents of ``$USERNAME.pub``.
You will now be able to SSH into Skynet like so: You will now be able to SSH into Skynet like so:

View file

@ -1,11 +1,42 @@
# Create your own website on Skynet # Create your own website on Skynet
## Login One of the services that Skynet provides is access to a Linux server which also has a webserver.
Once ye have [logged in](./create_ssh.md) you will be able to create a website on Skynet. Additionally each member gets their own domain:
* ``$USERNAME.users.skynet.ie``
* This is the core web address
* <https://silver.users.skynet.ie>
* ``skynet.ie/~$USERNAME``
* This is backwards compatible to help avoid link rot
* Redirects to the core address above
* <https://skynet.ie/~silver>
## Website ## Website
### Manually 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
Once ye have [logged in](./create_ssh.md) you will be able to create a website on Skynet.
#### Create Files
In your home folder follow these commands to create the folder that can be used to host a website In your home folder follow these commands to create the folder that can be used to host a website
```bash ```bash
@ -15,12 +46,32 @@ chmod -R 755 ~/public_html
cd ~/public_html cd ~/public_html
``` ```
To transfer files graphically you can use these programs: In this directory you can create all the relevant files using ``nano`` or ``vim``.
* WinSCP
* FileZilla
Anything put there will be accessible under ``https://$USERNAME.users.skynet.ie``. ```bash
For backwards compatability ``https://skynet.ie/~$USERNAME`` will redirect to ``https://$USERNAME.users.skynet.ie``. # 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][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``.
## More info ## More info
There is a slideshow that might be of use to you: <https://public.skynet.ie/slides/skynet/1_setup.html> There is a slideshow that might be of use to you: <https://public.skynet.ie/slides/skynet/1_setup.html>