Skip to content

Commit 1276723

Browse files
TommyOh0428TommyOh0428
authored
Merge pull request #27 from sfuosdev/wsl_doc
Wsl doc
2 parents b361e43 + 9195d15 commit 1276723

8 files changed

+223
-2
lines changed

‎docs/code-styling/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Intro to Code Styling",
3-
"position": 3,
3+
"position": 4,
44
"link": {
55
"type": "generated-index",
66
"description": "Examples of basic code-styling and why it's important."

‎docs/git_docs/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Git Documentation",
3-
"position": 2,
3+
"position": 3,
44
"link": {
55
"type": "generated-index"
66
}

‎docs/tutorial-wsl/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Tutorial - WSL",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Installation guide for WSL for both Windows and MacOS."
7+
}
8+
}

‎docs/tutorial-wsl/image.png

19.3 KB
Loading

‎docs/tutorial-wsl/sfu-vpn.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Why VPN is crucial
6+
A **VPN (Virtual Private Network)** is crucial because it protects your online privacy and security by encrypting your internet connection, hiding your IP address, and preventing unauthorized access to your data. It is especially vital when using public Wi-Fi, as it safeguards against hackers and cyber threats. Additionally, a VPN allows you to bypass geographical restrictions, access region-locked content, and avoid censorship, ensuring an open and secure internet experience.
7+
8+
![](https://sosafe-awareness.com/sosafe-files/uploads/2024/01/VPN_Glossary_2-1024x456.png) \
9+
A youtube video explaining the functionalities of VPN can be viewed [**(here)**](https://youtu.be/CWy3x3Wux6o?si=Lld_PYizzgmw0iH3)
10+
11+
---
12+
13+
## The Minimum requirements for SFU VPN
14+
- [Windows](https://docs.fortinet.com/document/forticlient/6.4.3/windows-release-notes/549781/product-integration-and-support)
15+
- [Mac](https://docs.fortinet.com/document/forticlient/6.4.3/macos-release-notes/471180/product-integration-and-support)
16+
- [Linux](https://docs.fortinet.com/document/forticlient/6.4.3/linux-release-notes/136392/product-integration-and-support)
17+
18+
---
19+
20+
## What is MFA?
21+
Multi-Factor Authentication, or MFA for short is an authentication method that requires the user to provide two or more verification factors to gain access to a resource such as an application, online account, or a VPN.
22+
23+
![](https://www.onelogin.com/images/patterns/text-image/high-level-mfa.svg)
24+
25+
26+
## How does MFA work?
27+
MFA works by requiring additional verification information (factors). One of the most common MFA factors that users encounter are one-time passwords (OTP). OTPs are those 4-8 digit codes that you often receive via email, SMS or some sort of mobile app. With OTPs a new code is generated periodically or each time an authentication request is submitted.
28+
29+
For more information click [(here)](https://www.fortinet.com/resources/cyberglossary/multi-factor-authentication)
30+
31+
32+
## How to install SFU VPN
33+
Referring to the official SFU website, you'll need the following to access SFU's VPN network
34+
1. An SFU account (faculty, staff or graduate students) that is enrolled in SFU's Multi-Factor Authentication.
35+
2. The free version of the FortiClient VPN app. See Install the Fortinet VPN App.
36+
3. The connection settings listed below.
37+
38+
39+
![alt text](image.png)
40+
41+
---
42+
43+
For additional information please refer to the official [**(SFU website)**](https://sfu.teamdynamix.com/TDClient/255/ITServices/KB/ArticleDet?ID=3973)

‎docs/tutorial-wsl/why-wsl.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Why You Should Use Windows Subsystem for Linux (WSL)
6+
7+
Windows Subsystem for Linux (WSL) is a feature in Windows that allows users to run a full Linux environment without the need for a virtual machine or dual booting. Here's why you should consider using WSL:
8+
9+
---
10+
11+
## **1. Lightweight and Fast**
12+
- **No Virtualization Overhead:** Unlike traditional VMs, WSL doesn't require allocating hardware resources like RAM or CPU.
13+
- **Instant Startup:** WSL launches immediately, providing near-instant access to Linux.
14+
15+
---
16+
17+
## **2. Developer-Friendly**
18+
WSL is a fantastic tool for developers who want to:
19+
- Run Linux tools and scripts directly on Windows.
20+
- Develop in Linux-optimized languages like Python, Node.js, or Ruby.
21+
22+
---
23+
## **3. Course / Work Requirements**
24+
- Courses such at **CMPT 125**, **CMPT 130**, **CMPT 135**, **CMPT 225** requires Linux to do Assignments and Projects.
25+
- Coops may manage servers, **Security**, **Embedded**, **Systems** with **Linux**
26+
---
27+
28+
## **Who Should Use WSL?**
29+
- **Web Developers:** Optimize workflows with Linux tools and environments.
30+
- **Data Scientists:** Use Python and ML tools natively on Linux.
31+
- **System Admins:** Test and run Linux scripts directly on Windows.
32+
- **Linux Enthusiasts:** Explore Linux without leaving Windows.
33+
34+
---

‎docs/tutorial-wsl/wsl-installation_Windows.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# What is Windows Subsystem for Linux?
6+
Windows Subsystem for Linux (WSL) is a feature in Windows that allows you to run a Linux environment, including most command-line tools, utilities, and applications, directly on a Windows machine without the need for a separate virtual machine or dual-boot setup.
7+
8+
## Windows Subsystem for Linux (WSL) Installation Guide
9+
10+
### **Prerequisites**
11+
12+
Before you begin, ensure your system meets the following requirements:
13+
- **Windows 10:** Version 2004 or higher.
14+
- **Windows 11:** Any version.
15+
- Your system must be running **64-bit** architecture.
16+
17+
You can check your Windows version by pressing `Win + R`, typing `winver`, and pressing Enter.
18+
19+
## Windows
20+
21+
Steps:
22+
1. Download a Linus distribution ISO (e.g, Ubuntu) from the official site.
23+
2. Install your choice of VM tool on you Mac
24+
3. Create a new virtual machine and mount the ISO to install Linux.
25+
26+
## Installing WSL via Commands
27+
First you'll need to nagivate to your computer's PowerShell (Terminal) and run it as [**administrator**](https://learn.microsoft.com/en-us/windows/terminal/faq).\
28+
Type the following command to begin the Linux installation
29+
30+
```
31+
wsl --install
32+
```
33+
34+
This command will enable the features necessary to run WSL and install the Ubuntu distribution of Linux.
35+
**Warning** the above command only works if WSL is not installed at all.
36+
37+
## Install a Specific Linux Distribution
38+
- Open Microsoft Store
39+
- Search for your preferrred Linux distribution
40+
- [Ubuntu](https://ubuntu.com/download/desktop)
41+
- [Debian](https://www.debian.org/distrib/)
42+
- [Kali Linux](https://www.kali.org/get-kali/#kali-platforms)
43+
44+
## How to use WSL in Windows (VSCode)
45+
1. install the WSL extension in VSCode's extension tab
46+
2. Navigate to the folder you would like to open in VSCode
47+
3. Type the following in the terminal
48+
```
49+
code .
50+
```
51+
4. After a moment, a new VSCode will appear, and you will see this notification \
52+
53+
![alt text](https://code.visualstudio.com/assets/docs/remote/wsl/wsl-starting-notification.png)
54+
55+
Congratulation! You have successfully opened a WSL folder in VSCode.
56+

‎docs/tutorial-wsl/wsl-installation_macOS.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
## Usage of Linux on MacOS
6+
**MacOS** users needing a full Linux environment can use a virtual machine (VM) like VirtualBox or access a **Computer Science Instructional Lab (CSIL)** lab, where pre-configured Linux systems are available for development and testing.
7+
8+
## Virtual Machines
9+
The best way to utilize **Linux** in MacOS is to use a Virutal machine. \
10+
The following is a list of tools you can use to utilize Linux on MacOS
11+
- [VirtualBox](https://www.virtualbox.org/)
12+
- [Parallels Desktop](https://www.parallels.com/products/desktop/?utm_medium=cpc&utm_source=google&utm_campaign=PDfM%20-%20B%20-%20EN%20-%20PS%20-%20Tier1%20-%20Consolidated&utm_term=parallels%20desktop&utm_content=General&utm_id=43693686&extensionid=&matchtype=e&device=c&devicemodel=&creative=670597955224&network=g&placement=&x-source=ppc&gad_source=1&gclid=Cj0KCQiA-aK8BhCDARIsAL_-H9lFedZ818kCuJZZlEgaKsgUODiQpwheGeihp-XNp575bqQvPgHIAKAaAjVvEALw_wcB)
13+
- [VMware Fusion](https://blogs.vmware.com/teamfusion/2024/05/fusion-pro-now-available-free-for-personal-use.html)
14+
- [UTM](https://mac.getutm.app/)
15+
16+
There are many Virtual Machines out in the market but we personally recommand using **UTM** as it is free of use and it is macOS-native (Pre-installed)
17+
18+
## Recommended Linux Distribution for macOS Users
19+
| Name | Description |
20+
|------------------|------------------|
21+
| [Ubuntu](https://ubuntu.com/download/desktop) | User-friendly, great for beginners. |
22+
| [Pop!_OS](https://pop.system76.com/) | Optimized for productivity and developers. |
23+
| [Fedora](https://fedoraproject.org/) | Cutting-edge features and polished experience. |
24+
| [Debian](https://www.debian.org/distrib/) | Stable and reliable. |
25+
| [Elementary OS](https://elementary.io/) | Designed with a macOS-like interface. |
26+
27+
## How to use Virtual Machine to use Linux
28+
For demonstration purposes we will be using Ubunto ISO file uploaded to the VirtualBox as an example. We will also assume that users have already downloaded the required VM and Linux distribution file before reading this part of the tutorial.
29+
30+
There exists four major steps when using Virtual machines.
31+
32+
- Creating a new Virtual Machine in VirtualBox
33+
- Mount the Linux ISO to the VM
34+
- Start the VM and download Linux
35+
- Complete Post installation setup
36+
37+
### Step 1 Creating a new Virtual Machine in VirtualBox
38+
1. Open VirtualBox:
39+
- Launch VirtualBox after installation.
40+
41+
2. Create a New VM:
42+
- Click the "New" button to create a new virtual machine.
43+
- Enter a name for your VM (e.g., "Ubuntu VM").
44+
- Choose the type of operating system (e.g., Linux) and version (e.g., Ubuntu (64-bit)).
45+
- Click Next.
46+
3. Assign Memory (RAM):
47+
48+
- Decide how much memory (RAM) you want to allocate to the VM.
49+
- For Ubuntu, a minimum of 2 GB is recommended, but 4 GB is better if your Mac has enough RAM.
50+
- Click Next.
51+
4. Create a Virtual Hard Disk:
52+
53+
- Choose Create a virtual hard disk now and click Create.
54+
- Choose the format for the virtual disk (e.g., VDI).
55+
- Choose the type of storage (dynamically allocated is fine).
56+
- Set the size of the virtual hard disk (e.g., 20 GB is a reasonable minimum).
57+
- Click Create.
58+
59+
### Step 2 Mount the Linux ISO to the VM
60+
- Mount the ISO:
61+
- In the settings window, go to Storage.
62+
- Under Controller: IDE, you’ll see an empty disk. Click the empty disk icon and then click the disk icon next to Optical Drive on the right.
63+
- Select Choose a disk file and navigate to the Ubuntu ISO file you downloaded earlier.
64+
- Select the ISO and click Open.
65+
- Click OK to save the settings.
66+
67+
### Step 3 Start the VM and download Linux
68+
-
69+
- start the VM
70+
- Install Linux
71+
72+
### Step 4 Complete Post installation setup
73+
1. log in to Linux with your login info
74+
2. Update the system by inputing the following commands to the terminal
75+
76+
```
77+
sudo apt update && sudo apt upgrade
78+
```
79+
80+
## Follow along a youtube tutorial on getting started with VMs [**(Here)**](https://youtu.be/FeJyAjDoLEw?si=_92-ksvIbqvLyfmr)

0 commit comments

Comments
 (0)