Skip to content

Commit

Permalink
Add content to getting started guides
Browse files Browse the repository at this point in the history
  • Loading branch information
matiasilva committed Sep 8, 2021
1 parent b0a236c commit b6e0698
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 2 deletions.
34 changes: 34 additions & 0 deletions content/guides/getting-started-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,37 @@ layout: docs
group: getting-started-groups
---

## Note for beginners

It is becoming increasingly common that the role of “webmaster” is merged into the job of the secretary or the publicity officer. This often means that modifying the website becomes a daunting task due to unfamiliarity with the relevant technical aspects and/or the SRCF. We’ve tried to lower the barriers to entry by writing helpful tutorials with beginners in mind. If you are new to this, please do not be discouraged as we are here to help! We offer several ways of [getting help]({{< relref "/#help-and-support" >}}), including a live chat.

As a quick introduction, the Student-Run Computing Facility is best known (though we do other things!) for providing free web hosting and email forwarding for students in Cambridge.

*The above is copied from our society handovers guide.*

## Users vs. groups

Even as a society webmaster, or someone looking to setup a website for a group, you are first and foremost a user. This means that our getting started guide for users is entirely applicable (and useful) to you. The main difference is that your `public_html` is now a shared between all the admins of your group.

In your home directory, a shortcut (symbolic link) to your group's file space is automatically created, and in it is the `public_html` you will want. This is also a shortcut to your group's *public* file space, which contains the actual `public_html` directory. Here is a useful breakdown that also includes the absolute file paths:

```bash
spqr2@pip:~$ ls -l
mysociety1 -> /societies/mysociety1
mysociety2 -> /societies/mysociety2
public_html -> /public/home/spqr2/public_html
```

```bash
spqr2@pip:~$ cd mysociety1
spqr2@pip:~$ pwd -P
/societies/mysociety1
spqr2@pip:~$ ls -l
public_html -> /public/societies/mysociety1
```

## Your options

The fact that you are given full access to our webserver means that you have many many different possibilities in the types of websites you can host: dynamic or static, custom made vs. a standard content management system (CMS), PHP vs. Python, the list of options goes on.

There are different usecases, and different levels of technical skill required by each, so choose the one the makes the most sense for you and your group. A good chunk of societies tend to favor the PHP-powered WordPress CMS, which is why we've [written a special guide]({{< relref "tutorials/websites/wordpress-from-scratch" >}}) for it to make sure you install it properly and securely.
44 changes: 43 additions & 1 deletion content/guides/getting-started-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,48 @@ layout: docs
group: getting-started-users
---

## Introduction

If you are a new user and wondering what to do, this guide is your first port of call. Here, we go through the process of getting familiar with the main services the SRCF offers you and how to work with them. It is worth mentioning that we have various [tutorials]({{< relref "tutorials" >}}) that break down the steps shown here into much more detail, with a beginner-first approach in mind.

## Create an account

To start with, you'll need to [create a personal
account](https://control.srcf.net/signup). This will allow you to use
the control panel to add more services.
the control panel to manage our various services.

## Connect to the shell server

The primary way to connect to our public facing servers is via a protocol known as SSH. Make sure to [read our tutorial]({{< relref "tutorials/shell-and-files/logging-in" >}}) on that, and come back once you've finished!

## Upload your first website

Now, let's create your first website on the SRCF. Remember the `public_html` directory you saw in your home directory when you first logged in? Any file in that directory is served by `sinkhole`, our webserver, on the domain `<yourCRSid>.user.srcf.net`. By default, webservers look for an `index.html` page to serve, otherwise they'll list the files in your `public_html` directory, which isn't very user friendly.

{{< alert type="danger" >}}
As indicated by the name, you should not place any private files, for example files that contain secrets, in the `public_html` directory. They will be publicly accessible under your default SRCF domain.
{{< /alert >}}

First, ensure that you are now in the `public_html` directory by changing into it: `cd public_html`. To create a simple file, we use the text editor "nano", by typing the command followed by the name of the file we want to create: `nano index.html`. You are now freely able to type any text you wish, so let's add the following HTML by copying and pasting into your terminal.

{{< alert type="info" >}}
If you are not familiar with HTML and CSS and how websites work, then don't fret. There are plenty of very good resources on the web for this. Simply typing into a search engine should help you go a long way! The content below is sourced [this page](https://www.w3schools.com/w3css/w3css_web_html.asp).
{{< /alert >}}

```html
<!DOCTYPE html>
<html lang="en">
<meta charset="UTF-8">
<title>I love the SRCF</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<body>
<h1>Hello there!</h1>
</body>
</html>
```

Now press "ctrl-o" then enter to confirm the file name, followed by "ctrl-x" to exit the editor. You should now be able to see a "Hello there!" on your SRCF domain.

## Now what?

Believe it or not, the basic skills shown here cover most of what you should need to make use of our shell server and our webserver. You are welcome to browse our other tutorials for more advanced information, or simply play around with the Linux environment we offer you!
2 changes: 1 addition & 1 deletion content/guides/society-handovers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This guide is written with societies in mind as they tend to have regular annual

## New webmasters

It is becoming increasingly common that the role of "webmaster" is merged into the job of the secretary or the publicity officer. This often means that modifying the website becomes a daunting task due to unfamiliarity with the relevant technical aspects and/or the SRCF. We've tried to lower the barriers to entry by writing helpful tutorials with beginners in mind. If you are new to this, please do not be discouraged as we are here to help! We offer several ways of [getting help]({{< relref "/#help-and-support" >}}), including live chat.
It is becoming increasingly common that the role of "webmaster" is merged into the job of the secretary or the publicity officer. This often means that modifying the website becomes a daunting task due to unfamiliarity with the relevant technical aspects and/or the SRCF. We've tried to lower the barriers to entry by writing helpful tutorials with beginners in mind. If you are new to this, please do not be discouraged as we are here to help! We offer several ways of [getting help]({{< relref "/#help-and-support" >}}), including a live chat.

As a quick introduction, the Student-Run Computing Facility is best known for providing free web hosting and email forwarding for students in Cambridge.

Expand Down

0 comments on commit b6e0698

Please sign in to comment.