Compare commits

..

No commits in common. "main" and "imap-and-tutorial-sieve" have entirely different histories.

5 changed files with 16 additions and 79 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 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 ```bash
git config --local core.hooksPath .githooks/ git config --local core.hooksPath .githooks/

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 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: 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 the spam folder. * You may need to check teh 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,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`` ``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver``
## Windows ## Create Key
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
@ -15,22 +12,13 @@ mkdir -f -p ~/.ssh/skynet
cd ~/.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 ```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
@ -79,7 +67,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 the file. This is what we want to have in teh file.
``` ```
Host *.skynet.ie Host *.skynet.ie
User $USERNAME User $USERNAME
@ -91,7 +79,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 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: You will now be able to SSH into Skynet like so:

View file

@ -1,42 +1,11 @@
# Create your own website on Skynet # Create your own website on Skynet
One of the services that Skynet provides is access to a Linux server which also has a webserver. ## Login
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
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. 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 In your home folder follow these commands to create the folder that can be used to host a website
```bash ```bash
@ -46,32 +15,12 @@ chmod -R 755 ~/public_html
cd ~/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: To transfer files graphically you can use these programs:
* WinSCP
* [WinSCP][download_winscp] * FileZilla
* 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 ## 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>