From c3b69e95dcd4d76343e61de28a3ae1145d7ff1d8 Mon Sep 17 00:00:00 2001
From: Evy Garden <julian.storozhenko@tu-dortmund.de>
Date: Sun, 10 Sep 2023 16:25:00 +0200
Subject: [PATCH] inital commit

---
 README.md | 249 +++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 179 insertions(+), 70 deletions(-)

diff --git a/README.md b/README.md
index c2cb1a5..809f0ab 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,201 @@
-# BS-SSH-Tutorial
-
-
-
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
+# SSH Guide für BS
+
+## Inhaltsverzeichniss
+1. IRB VPN Einrichtung
+    + Verweis auf OpenVPN guide der IRB
+2. SSH Einrichtung
+    + Erstanmeldung
+    + Übertragung des Schlüssels (Optional)
+    + Konfiguration der ssh Datei
+3. Kurze `sh` Einführung
+    + Navigation mit `cd`, `ls`, `pwd`
+    + Dateimanipulation mit `cp`, `mv`, `rm`
+    + Dateien bearbeiten mit `nano`, `vim`[optional]
+    + Dateien Empfangen mit `wget`, `curl`
+    + Dateien extrahieren mit `unzip`
+    + Dateien kompilieren mit `gcc`, `make`
+    + Dateien ausführen mit `./a.out`
+4. Visual Studio Code over ssh
+    + SSH remote extension installieren und ssh ausführen
+    + Projektordner öffnen
+    + Projekt kompilieren
+    + Datei übertragen
+
+## IRB VPN Einrichtung
+
+### Vorwort
+Das Virtual Private Network (VPN) ist ein Werkzeug mit dem ihr euch auch von zuhause aus im internen Netzwerk der Uni bewegen könnt.
+Die Idee dahinter ist, dass ich mit einem virtuellen Netzwerk verbindet, welches euch Zugriff auf beispielsweise die Server des IRB gibt.
+
+Als Studierende im Fach Informatik könnt ihr euch einen Pool-Account beim IRB machen und mit den Zugangsdaten dann auch das vom IRB bereitgestellte VPN nutzen.
+
+### Anleitung
+1. Macht euch einen IRB Pool-Account, falls ihr noch keinen habt.
+2. Geht auf oh14.de/vpn und versucht mit der Guide das VPN bei euch aufzusetzen.
+    > Für Linux: Auf Linux Distributionen soll NetworkManager genutzt werden. Jedoch funktioniert das Aufgrund des Formats der `.ovpn`-Datei nicht. Nutzt stattdessen den `openvpn` Befehl direkt.
+    > `$ sudo openvpn --config vpn_client.ovpn`
+3. Loggt euch im VPN mit eurem IRB Mail-Nutzernamen und eurem IRB Pool Passwort ein.
+    > Euren Mail-Nutzernamen findet Ihr, wenn ihr [hier einloggt](https://irb.cs.tu-dortmund.de/cont/de/account/myacc/login/index.html) und navigiert zu
+    > `> Accounts Verwalten > Status-Info : Mail-Account`
+4. Jetzt solltet ihr im VPN sein. Bei Fragen sind die Kontaktdaten auf der Seite. Sobald ihr fertig seid, schaltet die VPN wieder ab.
+
+## SSH Einrichtung
+
+### Vorwort
+SSH ist ein Protokoll über welches eine sichere Verbindung zu einem anderen Gerät aufgebaut werden kann, worüber eine Shell geöffnet wird.
+Eine Shell ist ein Programm, über welches mithilfe von Text-Kommandos ein Computer bedient werden kann.
+
+Wenn ihr also auf dem IRB Pool von zuhause arbeiten wollt, könnt ihr eine SSH Verbindung zu einem der IRB Servern aufbauen und dort über die Shell arbeiten.
+
+### Anleitung: Linux/MacOS/*nix
+1. Verbindet euch mit der IRB VPN.
+2. Falls die Datei `~/.ssh/config` noch **nicht** existiert, fügt diese hinzu.
+```shell=
+touch ~/.ssh/config
+chmod 600 ~/.ssh/config
 ```
-cd existing_repo
-git remote add origin https://gitlab.fachschaften.org/evysgarden/bs-ssh-tutorial.git
-git branch -M main
-git push -uf origin main
+3. Fügt in die Datei `~/.ssh/config` folgendes hinzu:
+```yaml
+Host uran polonium promethium plutonium bohrium technetium
+  User IRB_NUTZERNAME
+  HostName %h.cs.tu-dortmund.de
 ```
+> ersetzt dabei `IRB_NUTZERNAME` mit eurem IRB Nutzernamen (bspw. `muster00`).
 
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.fachschaften.org/evysgarden/bs-ssh-tutorial/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
+4. Jetzt könnt ihr euch mit den servern ganz leicht über SSH verbinden. Gebt dazu einfach bspw `ssh uran` ein, um euch mit dem `uran` server zu verbinden.
+> Als Passwort nutzt ihr euer IRB Passwort.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+#### Optional: SSH Keypair
+Wenn ihr nicht jedes mal euer IRB Passwort rauskramen wollt oder gar kein Passwort eingeben wollt, könnt ihr statt der Passwort Authentizierung auch ein Schlüsselpaar generieren und diesen an den Server übertragen.
 
-***
+1. Generiert ein Schlüsselpaar, wenn ihr nicht schon eins benutzt:
+```shell
+ssh-keygen -t ed25519
+```
+Wenn ihr nicht jedes mal ein Passwort eingeben wollt, könnt ihr das Passwort-Feld leer lassen oder einen [SSH Agent](https://wiki.archlinux.org/title/SSH_keys#SSH_agents) nutzen.
 
-# Editing this README
+2. Übertragt den öffentlichen Teil des Schlüssels an den server:
+```shell
+ssh-copy-id -i ~/.ssh/id_ed25519 -o PreferredAuthentications=password uran
+```
+3. Wenn alles geklappt hat, könnt ihr euch jetzt beim einloggen mit dem Passwort eures Schlüsselpaares (falls ihr eins habt) einloggen.
+
+## SH Einführung
+
+### Vorwort
+Ihr seid jetzt in einer Shell, wahrscheinlich `bash` ([Bourne Again SHell](https://www.gnu.org/software/bash/)).
+Eine Shell ist vergleichbar mit der `cmd.exe` oder `powershell.exe` unter Windows oder `zsh` unter MacOS. Es ist ein Programm, welches euch eine Umgebung bietet, in welcher ihr beliebig andere Programme aufrufen könnt über die reine Eingabe von Text.
+
+### Das Shell Interface
+```shell
+muster00@uran:~$
+^        ^    ^  ^
+|        |    |  \ Eingabe
+|        |    \ Momentanes Arbeits-Verzeichnis ("~" ist "/home/muster00")
+|        \ Hostname der Maschine
+\ Username
+```
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+### Navigation
+Ihr befindet euch momentan in eurem HOME-Verzeichnis.
+Das ist das Verzeichnis eures Users.
+
+Guckt euch gerne um mithilfe der folgenden Befehle
+###### `ls`
+Listet alle Dateien in dem angegebenen Verzeichnis oder om momentanen Arbeits-Verzechnis, falls kein Pfad angegeben wurde.
+```shell
+$ ls
+Documents Downloads Games Pictures Videos Desktop Music
+$ ls /tmp/foo
+bar
+```
 
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+###### 
+
+###### `cd`
+Wechselt das momentane Arbeits-Verzeichnis in das angebene.
+Wird kein Verzeichnis angegeben, so wechselt das Arbeitsverzechnis
+in das Heim-Verzechnis (`~`).
+```shell
+$ cd /tmp/foo
+$ ls
+bar
+$ cd
+$ ls
+Documents Downloads Games Pictures Videos Desktop Music
+```
 
-## Name
-Choose a self-explaining name for your project.
+###### `pwd`
+Gibt das momentane Arbeits-Verzeichnis zurück.
+```shell
+$ pwd
+/home/muster00
+```
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+###### `cp` & `mv`
+Die Kopier und Bewegungs-Befehle haben einen ähnlichen Syntax. Der Unterschied ist, dass `mv` die ursprüngliche Datei löscht.
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+> Der `mv` Befehl wird auch zur Umbenennung von Dateien genutzt.
+```shell
+$ cp /tmp/foo/bar bar
+$ ls
+bar
+$ ls /tmp/foo
+bar
+$ mv bar baz
+$ ls
+baz
+```
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+###### `rm`
+Löscht die angegebene Datei.
+```shell
+$ ls
+baz
+$ rm baz
+$ ls
+$
+```
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+###### `wget`
+Lädt eine Datei über http/s runter und speichert diese im momentanen Arbeits-Verzechnis
+```shell
+$ wget https://example.org/example
+$ ls
+example
+$ rm example
+```
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+###### `unzip`
+Extrahiert eine `.zip`-Datei.
+```shell
+$ unzip example.zip
+$ ls
+example
+```
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+---
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+### Testprojekt
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+###### `CMakeFiles.txt`
+```cmake=
+cmake_minimum_required(VERSION 3.0.0)
+project(Test LANGUAGES C VERSION 0.0.1)
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+add_executable(main
+    ${PROJECT_SOURCE_DIR}/main.c
+)
+```
 
-## License
-For open source projects, say how it is licensed.
+###### `main.c`
+```c=
+#include <stdio.h>
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+int main() {
+  printf("hey world ^^\n");
+  return 0;
+}
+```
-- 
GitLab