Skip to content
Snippets Groups Projects
Commit b18543d3 authored by Hampölz, Rene's avatar Hampölz, Rene
Browse files

docs: Format files

parent cfd5a41b
No related branches found
No related tags found
No related merge requests found
{
"editor.tabSize": 4
}
...@@ -20,14 +20,15 @@ Docker uses this as a backend on Windows to run containers. ...@@ -20,14 +20,15 @@ Docker uses this as a backend on Windows to run containers.
You can find more information here: https://learn.microsoft.com/en-us/windows/wsl/. You can find more information here: https://learn.microsoft.com/en-us/windows/wsl/.
To enable WSL, follow the steps below: To enable WSL, follow the steps below:
1. Ensure that virtualization is enabled in the BIOS. If you are not sure how you can do this, use the following guide: https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-c5578302-6e43-4b4b-a449-8ced115f58e1 1. Ensure that virtualization is enabled in the BIOS. If you are not sure how you can do this, use the following guide: https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-c5578302-6e43-4b4b-a449-8ced115f58e1
2. Open PowerShell or Windows Command Prompt in **administrator** mode by right-clicking and selecting "*Run as administrator*". 2. Open PowerShell or Windows Command Prompt in **administrator** mode by right-clicking and selecting "_Run as administrator_".
3. Enter the command `wsl --install` inside the terminal window. 3. Enter the command `wsl --install` inside the terminal window.
4. Restart your machine. 4. Restart your machine.
If you encounter issues when enabling WSL even though you activated the **Virtual Machine Platform** Windows feature _(this will normally be activated automatically by WSL)_ as well as virtualization in the BIOS, try the following steps: If you encounter issues when enabling WSL even though you activated the **Virtual Machine Platform** Windows feature _(this will normally be activated automatically by WSL)_ as well as virtualization in the BIOS, try the following steps:
1. Open PowerShell or Windows Command Prompt in **administrator** mode by right-clicking and selecting "*Run as administrator*". 1. Open PowerShell or Windows Command Prompt in **administrator** mode by right-clicking and selecting "_Run as administrator_".
2. Enter the command `bcdedit /set hypervisorlaunchtype auto` inside the terminal window. 2. Enter the command `bcdedit /set hypervisorlaunchtype auto` inside the terminal window.
3. Restart your machine. 3. Restart your machine.
...@@ -38,7 +39,7 @@ If you encounter issues when enabling WSL even though you activated the **Virtua ...@@ -38,7 +39,7 @@ If you encounter issues when enabling WSL even though you activated the **Virtua
3. When prompted, ensure to select the option `Use WSL 2 instead of Hyper-V`. 3. When prompted, ensure to select the option `Use WSL 2 instead of Hyper-V`.
4. Follow the instructions on the installation wizard to authorize the installer and proceed with the install. 4. Follow the instructions on the installation wizard to authorize the installer and proceed with the install.
5. During the installation you may be prompted to restart your machine. The installation will continue after the restart. 5. During the installation you may be prompted to restart your machine. The installation will continue after the restart.
6. When the installation is successful, select *Close* to complete the installation process. 6. When the installation is successful, select _Close_ to complete the installation process.
7. Open the Docker application and accept the terms of use. If a problem has occurred, you will be informed on the next page. 7. Open the Docker application and accept the terms of use. If a problem has occurred, you will be informed on the next page.
Next steps: [Setting up and using the OOP1 dev container](devcontainer.md) Next steps: [Setting up and using the OOP1 dev container](devcontainer.md)
...@@ -61,6 +62,7 @@ On Linux you can use Docker Desktop or the docker CLI. We strongly recommend to ...@@ -61,6 +62,7 @@ On Linux you can use Docker Desktop or the docker CLI. We strongly recommend to
If you still prefer to use the GUI application, you can find all the necessary instructions here: https://docs.docker.com/desktop/install/linux-install/ If you still prefer to use the GUI application, you can find all the necessary instructions here: https://docs.docker.com/desktop/install/linux-install/
To install the Docker CLI, execute the following command: To install the Docker CLI, execute the following command:
```bash ```bash
curl -fsSL https://get.docker.com | sh curl -fsSL https://get.docker.com | sh
``` ```
...@@ -70,4 +72,3 @@ curl -fsSL https://get.docker.com | sh ...@@ -70,4 +72,3 @@ curl -fsSL https://get.docker.com | sh
Next steps: [Setting up and using the OOP1 dev container](devcontainer.md) Next steps: [Setting up and using the OOP1 dev container](devcontainer.md)
If you encounter problems, check the official installation instructions: https://docs.docker.com/engine/install/#supported-platforms If you encounter problems, check the official installation instructions: https://docs.docker.com/engine/install/#supported-platforms
...@@ -10,12 +10,11 @@ To be able to clone your project from the [TU Graz GitLab](https://gitlab.tugraz ...@@ -10,12 +10,11 @@ To be able to clone your project from the [TU Graz GitLab](https://gitlab.tugraz
- [Linux](#linux) - [Linux](#linux)
- [Generating a new SSH key](#generating-a-new-ssh-key) - [Generating a new SSH key](#generating-a-new-ssh-key)
## Starting the the SSH Agent ## Starting the the SSH Agent
### Windows ### Windows
1. Open **PowerShell** in **administrator** mode by right-clicking and selecting "*Run as administrator*". 1. Open **PowerShell** in **administrator** mode by right-clicking and selecting "_Run as administrator_".
2. If your Windows instance provides an OpenSSH version <= 8.8, you need to update it. ([due to a problem at Microsoft](https://github.com/Microsoft/vscode-remote-release/issues/8666)) To check your version, use the command `ssh -V`. If you see **OpenSSH_for_Windows_8.8** or a lower version, update it with the following command: `winget install --id Microsoft.OpenSSH.Beta`. 2. If your Windows instance provides an OpenSSH version <= 8.8, you need to update it. ([due to a problem at Microsoft](https://github.com/Microsoft/vscode-remote-release/issues/8666)) To check your version, use the command `ssh -V`. If you see **OpenSSH_for_Windows_8.8** or a lower version, update it with the following command: `winget install --id Microsoft.OpenSSH.Beta`.
- If `ssh` does not work for you, install it using the `winget` command above. - If `ssh` does not work for you, install it using the `winget` command above.
- If `winget` does not work for you, you can also use the installer directly from https://github.com/PowerShell/Win32-OpenSSH/releases/latest - If `winget` does not work for you, you can also use the installer directly from https://github.com/PowerShell/Win32-OpenSSH/releases/latest
...@@ -67,7 +66,7 @@ Next steps: [Generating a new SSH key](#generating-a-new-ssh-key) ...@@ -67,7 +66,7 @@ Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
3. Reload your shell: `exec fish`. 3. Reload your shell: `exec fish`.
4. Run `fundle install`. 4. Run `fundle install`.
5. Add `ssh-add 2> /dev/null` to the end of your `config.fish` file. 5. Add `ssh-add 2> /dev/null` to the end of your `config.fish` file.
- *Note: This will hide the output of the command. If you want to show the output every time you open a new fish console just leave the `2> /dev/null` out.* - _Note: This will hide the output of the command. If you want to show the output every time you open a new fish console just leave the `2> /dev/null` out._
Your keys should now be automatically added and the agent is now starting automatically. Your keys should now be automatically added and the agent is now starting automatically.
...@@ -91,7 +90,7 @@ You should be able to generate a key with the `ssh-keygen` command on any operat ...@@ -91,7 +90,7 @@ You should be able to generate a key with the `ssh-keygen` command on any operat
5. Copy the content of your public key. To display the content, execute one of the following commands: 5. Copy the content of your public key. To display the content, execute one of the following commands:
- Windows: `type "$Env:USERPROFILE/.ssh/tugraz_rsa.pub"` - Windows: `type "$Env:USERPROFILE/.ssh/tugraz_rsa.pub"`
- Linux / MacOS: `cat ~/.ssh/tugraz_rsa.pub` - Linux / MacOS: `cat ~/.ssh/tugraz_rsa.pub`
6. Log into the [TU Graz GitLab](https://gitlab.tugraz.at/) and click on "*Edit profile*". Then go to the "*SSH key*" page in the right menu. Add a new key and paste your public key from the clipboard into the key field. 6. Log into the [TU Graz GitLab](https://gitlab.tugraz.at/) and click on "_Edit profile_". Then go to the "_SSH key_" page in the right menu. Add a new key and paste your public key from the clipboard into the key field.
Alongside the public key, a private key was also created. It usually has the same name as the public key, but without the `.pub` extension. In this case, the public key is named `tugraz_rsa.pub` and the private key `tugraz_rsa`. **You should never share this private key with anyone!** Anyone who has access to your private key also has access to your [TU Graz GitLab](https://gitlab.tugraz.at/) account. Alongside the public key, a private key was also created. It usually has the same name as the public key, but without the `.pub` extension. In this case, the public key is named `tugraz_rsa.pub` and the private key `tugraz_rsa`. **You should never share this private key with anyone!** Anyone who has access to your private key also has access to your [TU Graz GitLab](https://gitlab.tugraz.at/) account.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment