diff --git a/src/skynet/services/account.md b/src/skynet/services/account.md new file mode 100644 index 0000000..70a2710 --- /dev/null +++ b/src/skynet/services/account.md @@ -0,0 +1,49 @@ +# Skynet account +A Skynet account provides access to all the services listed in this wiki. + +To manage the account we have a self-service way to sign up for an account, change password, add ssh keys and more. + +## Committee/Admins +Committee and Skynet Admins are required to have a Skynet account in order to have access to internal materials. + +## Sign up +#### + +A Computer Society member is able to use this page to sign up for a Skynet account. +By entering the email address used for Wolves they will be sent a mail with instructions on how to proceed. + +## Modify +Various aspects of the account can be modified, such as: + +### Password +#### +If you know your existing password it can be changed here. + +### SSH Keys +#### +SSH keys are used for accessing the [Skynet Webserver](./skynet.md). +If you are on campus they are also usable for the [Forgejo instance](./forgejo.md). + +You can have multiple keys associated with your account. + +### User Information +#### +On Signup details such as email, first name and surname are pulled from UL Wolves, which itself pulls (for students) from UL. +This means that for some members their names does not match reality and this allows them to correct that. + +It also allows members upon graduation to switch to their own email address for Wolves instead of the UL provided email. + +## Recovery +Shit happens, memory fades, bits flip and ye find yourself unable to login. + +### Username +#### +If you have forgotten your username a reminder can be sent to the email linked to your account. + +### Password +#### +If you forget your password a reset link can be sent to the email linked to your account. + + + + diff --git a/src/skynet/services/discord.md b/src/skynet/services/discord.md new file mode 100644 index 0000000..bae47a6 --- /dev/null +++ b/src/skynet/services/discord.md @@ -0,0 +1,11 @@ +# Discord +### + +While we dont host our Discord server it is one fo the services we have for members. + +We used to have an [IRC](https://en.wikipedia.org/wiki/IRC) server, however that had a high onboarding cost for users and it was shut down a few years ago. +The modern equivalent would be Matrix, of which we could have a Discord bridge to keep the two communities connected. + +## Bot +### +We have a discord bot to manage membership on the discord, as well as manage the Minecraft Whitelist. diff --git a/src/skynet/services/email.md b/src/skynet/services/email.md new file mode 100644 index 0000000..b3f758f --- /dev/null +++ b/src/skynet/services/email.md @@ -0,0 +1,33 @@ +# Email + +Skynet offers an email to all members. +It is ``username@skynet.ie`` + +## Login +### Roundcube +#### +Use your Skynet ``username@skynet.ie`` and ``password`` to login. + +### Nextcloud +#### +Our [Nextcloud instance](./nextcloud.md) has an inbuilt mail module. +See [Nextcloud](./nextcloud.md) page for more info on logging in. + +### Thunderbird +#### +Thunderbird is an email client made by Mozilla. +Honestly it is one of the best email clients out there. + +They are working on exchange (Outlook/Office 365) support so ye will be able to use it for your UL email. +This work is being done with Rust. + +Use your Skynet ``username@skynet.ie`` and ``password`` to login. + +## Sieve Scripts +Sieve scripts allow you to sort and manage yer email in a programmatic way. + +Recommended tool: +Small tutorial will follow later. + +### Committee/Admins +There is an inbuilt sieve script that passes mail from committee/admin addresses into a folder in their Skynet inbox. diff --git a/src/skynet/services/forgejo.md b/src/skynet/services/forgejo.md new file mode 100644 index 0000000..caf0dde --- /dev/null +++ b/src/skynet/services/forgejo.md @@ -0,0 +1,15 @@ +# Forgejo +### + +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 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. + +## Login +Use your Skynet ``username`` and ``password`` to login. + +## Administration +Skynet Admins are automatically granted admin rights on Forgejo, this is done via LDAP \ No newline at end of file diff --git a/src/skynet/services/gitlab.md b/src/skynet/services/gitlab.md new file mode 100644 index 0000000..00e04fa --- /dev/null +++ b/src/skynet/services/gitlab.md @@ -0,0 +1,19 @@ +# Gitlab +### + +Gitlab is an online git repo hosting service. +Access to these repos is provided via SSH and HTTP (Although only HTTP is available off campus). +It has a solid CI/CD platform which uses its own YAML based config system. +Finally it has "folders" such as ``owner/folder/repo`` and ``owner/as/many/folders/as/ye/want/repo`` which allows for hierarchical grouping of repos. + +## Depreciation +Skynet currently hosts a Gitlab instance, however it is currently being depreciated in favor of [Forgejo](./forgejo.md). + +This is largely due to the administrative overhead involved in running a Gitlab CE instance. +Much of the LDAP based tools are locked behind the Enterprise (EE) licence. +These tools come automatically with Forgejo. + +Forgejo has another advantage of being able to use Github actions, which more folks are familiar with over Gitlab. + +One final reason is that the resources required to host Forgejo and its runner are far less than what are required to host Gitlab and its runner. + diff --git a/src/skynet/services/nextcloud.md b/src/skynet/services/nextcloud.md new file mode 100644 index 0000000..8a67b51 --- /dev/null +++ b/src/skynet/services/nextcloud.md @@ -0,0 +1,12 @@ +# Nextcloud +#### + +Nextcloud is ``What if Google but not Evil?``. +It consists of file storage, email client, web documents and more. + +## Login +Use your Skynet ``username`` and ``password`` to login. + + +## Committee/Admins +Committee and Admins have access to group folders which contain our long term data storage. \ No newline at end of file diff --git a/src/skynet/services/skynet.md b/src/skynet/services/skynet.md new file mode 100644 index 0000000..739ab3e --- /dev/null +++ b/src/skynet/services/skynet.md @@ -0,0 +1,94 @@ +# Skynet + +We provide a linux webserver webserver for member use. +It could be considered akin to the [Tildeverse](https://tildeverse.org/), named as such for the way each member's site was displayed (``https://skynet.ie/~username``). +Now that will redirect to ``https://username.users.skynet.ie`` we home to have preserved the same vibe. + +## Name +The main user facing server of the cluster has always been called Skynet, the cluster is named after this server. +You can find more of the history here: + +## Login +Login is done via ssh and ssh keys. + +### Create SSH key +First we set up the ssh folder and create a skynet folder within it for neatness +```bash +mkdir -f -p ~/.ssh/skynet +cd ~/.ssh/skynet +``` +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 "" +``` +It will create two files: ``username`` and ``username.pub`` + +### SSH Key +Head over to [adding ssh keys](./account.md#ssh-keys) to find information on adding ssh keys to your skynet account. + +it is the ``username.pub`` that you will be adding to your account. +To get the contents of the file do this. +```bash +cat username.pub +``` + +### SSH Config +Back up to the ``.ssh`` folder. +```bash +cd ../ +``` + +Now we have to create the config file. +Notice how it has no extension. +#### Windows +```powershell +"" > config +``` +Open it up in any text editor available to you. + +#### Linux +```bash +touch config +``` +You can edit it from command line using nano + +```bash +nano config +``` +Or open up in a text editor. + + +-------------------------------------- + +Windows and Linux pop this into the file and save it +``` +Host *.skynet.ie + User %r + IdentityFile ~/.ssh/skynet/%r + IdentitiesOnly yes +``` + +### Logging in +In any terminal do this: + +```bash +ssh username@skynet.skynet.ie +``` +And you will be in! + +## Website +In your home folder follow these commands to create the folder that can be used to host a website + +```bash +mkdir ~/public_html +chmod 711 ~ +chmod -R 755 ~/public_html +cd ~/public_html +``` + +See below for an easy way to upload files to this folder. + +## More info +There is a slideshow that might be of use to you: \ No newline at end of file