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

docs: Add more references to ssh-agent guide

parent 066c04bb
No related branches found
No related tags found
No related merge requests found
...@@ -10,6 +10,8 @@ The best way to get started is to read the following links step by step, everyth ...@@ -10,6 +10,8 @@ The best way to get started is to read the following links step by step, everyth
- [MacOS](docs/git.md#macos) - [MacOS](docs/git.md#macos)
- [Linux](docs/git.md#linux) - [Linux](docs/git.md#linux)
2. [SSH](docs/ssh.md) 2. [SSH](docs/ssh.md)
- [Starting the the SSH Agent](docs/ssh.md#starting-the-the-ssh-agent)
- [Generating a new SSH key](docs/ssh.md#generating-a-new-ssh-key)
3. [Docker](docs/docker.md) 3. [Docker](docs/docker.md)
- [Windows](docs/docker.md#windows) - [Windows](docs/docker.md#windows)
- [MacOS](docs/docker.md#macos) - [MacOS](docs/docker.md#macos)
......
...@@ -38,6 +38,9 @@ To use the container the VS Code **Dev Container** extension is required: ...@@ -38,6 +38,9 @@ To use the container the VS Code **Dev Container** extension is required:
### Open your assignment in the container ### Open your assignment in the container
> **IMPORTANT:** Make sure that you have set up the SSH authentication agent.
> You can find all the necessary information in our guide [Starting the the SSH Agent](ssh.md).
First you have to clone your assignment repository from [TU Graz GitLab](https://gitlab.tugraz.at/). You can choose whether you want to clone with Git or with VS Code, choose the one you prefer. First you have to clone your assignment repository from [TU Graz GitLab](https://gitlab.tugraz.at/). You can choose whether you want to clone with Git or with VS Code, choose the one you prefer.
1. Open your OOP1 assignment repository in [TU Graz GitLab](https://gitlab.tugraz.at/) 1. Open your OOP1 assignment repository in [TU Graz GitLab](https://gitlab.tugraz.at/)
......
...@@ -6,7 +6,7 @@ You should already have a basic understanding of this from other courses. ...@@ -6,7 +6,7 @@ You should already have a basic understanding of this from other courses.
If you need a quick refresher on this topic, here is a introduction from the largest Git hosting website **GitHub**: https://www.youtube.com/watch?v=r8jQ9hVA2qs If you need a quick refresher on this topic, here is a introduction from the largest Git hosting website **GitHub**: https://www.youtube.com/watch?v=r8jQ9hVA2qs
If you already have Git installed and set up on your system, you can skip this step and continue with [Setting up an SSH key pair](ssh.md). If you already have Git installed and set up on your system, you can skip this step and continue with [Starting the the SSH Agent](ssh.md).
## Table of contents ## Table of contents
...@@ -18,7 +18,7 @@ If you already have Git installed and set up on your system, you can skip this s ...@@ -18,7 +18,7 @@ If you already have Git installed and set up on your system, you can skip this s
Download and install Git from https://gitforwindows.org/. Download and install Git from https://gitforwindows.org/.
Next steps: [Setting up a SSH key pair](ssh.md) Next steps: [Starting the the SSH Agent](ssh.md)
## MacOS ## MacOS
...@@ -28,10 +28,10 @@ Simply type `xcode-select --install` into the terminal. ...@@ -28,10 +28,10 @@ Simply type `xcode-select --install` into the terminal.
There are also several other ways to install Git on MacOS, which are described in the official documentation: https://git-scm.com/downloads/mac There are also several other ways to install Git on MacOS, which are described in the official documentation: https://git-scm.com/downloads/mac
Next steps: [Setting up a SSH key pair](ssh.md) Next steps: [Starting the the SSH Agent](ssh.md)
## Linux ## Linux
Git may already be installed depending on your distribution, if not, you just have to install the `git` package with your package manager. Git may already be installed depending on your distribution, if not, you just have to install the `git` package with your package manager.
Next steps: [Setting up a SSH key pair](ssh.md) Next steps: [Starting the the SSH Agent](ssh.md)
...@@ -25,12 +25,16 @@ To be able to clone your project from the [TU Graz GitLab](https://gitlab.tugraz ...@@ -25,12 +25,16 @@ To be able to clone your project from the [TU Graz GitLab](https://gitlab.tugraz
Next steps: [Generating a new SSH key](#generating-a-new-ssh-key) Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
### MacOS ### MacOS
When using MacOS, the SSH authentication agent should be started automatically. When using MacOS, the SSH authentication agent should be started automatically.
Next steps: [Generating a new SSH key](#generating-a-new-ssh-key) Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
### Linux ### Linux
#### Bash & ZSH #### Bash & ZSH
...@@ -50,6 +54,10 @@ Next steps: [Generating a new SSH key](#generating-a-new-ssh-key) ...@@ -50,6 +54,10 @@ Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
fi fi
``` ```
Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
#### Fish #### Fish
1. Install the [Fundle plugin manager](https://github.com/danhper/fundle). 1. Install the [Fundle plugin manager](https://github.com/danhper/fundle).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment