From 8893dd2f57bd6d5cb0e5580d88d0ddf2e4c77f03 Mon Sep 17 00:00:00 2001 From: Jules van Rie Date: Sat, 8 Feb 2025 18:12:38 +0100 Subject: [PATCH 1/2] Correct SSH instructions --- _partials/ssh_key.md | 59 ++++++++++++++-------------------- _partials/virtual_machine.md | 12 +++++-- _partials/vscode_remote_ssh.md | 2 +- 3 files changed, 35 insertions(+), 38 deletions(-) diff --git a/_partials/ssh_key.md b/_partials/ssh_key.md index fada4ee..901f3cd 100644 --- a/_partials/ssh_key.md +++ b/_partials/ssh_key.md @@ -2,55 +2,46 @@ We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate. -- Open your terminal -
- 💡 Windows tip - -We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation -
+ Windows -- Create a SSH key + - We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation. + - Open Windows Terminal + - Run one of the following commands: + - If you're using _Windows PowerShell_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "your_email@example.com" + ``` + - If you're using the classic _Command Prompt_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "your_email@example.com" + ``` -
- Windows -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen.exe -t ed25519 -C "your_email@example.com" -```
MacOS & Linux -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -C "your_email@example.com" -``` + - Open your Terminal + - Run the following command: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" + ```
You should get the following message: `> Generating public/private algorithm key pair.` -- When you are prompted `> Enter a file in which to save the key`, press Enter -- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase. -ℹī¸ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons. +You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase. -- You should be asked to `Enter same passphrase again`, do it. +ℹī¸ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons. -**❗ī¸ You must remember this passphrase.** - -
- ❗ī¸ /home/your_username/.ssh/id_ed25519 already exists. -If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github). +You should be asked to `Enter same passphrase again`, do it. -To create a separate SSH key to exclusively use for this bootcamp use the following: - -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" -``` +**❗ī¸ You must remember this passphrase.** -Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later! -
+Your new SSH Key will be named `de-bootcamp`. diff --git a/_partials/virtual_machine.md b/_partials/virtual_machine.md index 4a493f4..a3e24f8 100644 --- a/_partials/virtual_machine.md +++ b/_partials/virtual_machine.md @@ -50,13 +50,19 @@ _Note: The following section requires you already have a [Google Cloud Platform] gcloud-console-add-manual-ssh-key - In your terminal display your public SSH key: - - Windows: navigate to where you created your SSH key and open `id_ed25519.pub` + - Windows: + ```bash + # If you use Windows Terminal + more $HOME\.ssh\de-bootcamp.pub + # OR if you use Command Prompt: + # more %HOMEPATH%\.ssh\de-bootcamp.pub + ``` - Mac/Linux users can use: ```bash - cat ~/.ssh/id_ed25519.pub - # OR cat ~/.ssh/de-bootcamp.pub if you created a unique key + cat ~/.ssh/de-bootcamp.pub ``` + - Copy your public SSH key and paste it: gcloud-console-add-ssh-key-pub diff --git a/_partials/vscode_remote_ssh.md b/_partials/vscode_remote_ssh.md index 29e3eaa..889a2cd 100644 --- a/_partials/vscode_remote_ssh.md +++ b/_partials/vscode_remote_ssh.md @@ -19,7 +19,7 @@ That's the only extension you should install on your _local_ machine, we will in vscode-connect-to-host - Click on `Add a new host` -- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa somedude@34.77.50.76` +- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp somedude@34.77.50.76` vscode-ssh-connection-command From 3c4cc2925be66cc88bf8cfc1209bf71c5c3cca40 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sat, 8 Feb 2025 17:12:58 +0000 Subject: [PATCH 2/2] setup guides generated --- LINUX.md | 73 ++++++++++++++++++++++++++---------------------------- WINDOWS.md | 73 ++++++++++++++++++++++++++---------------------------- macOS.md | 73 ++++++++++++++++++++++++++---------------------------- 3 files changed, 105 insertions(+), 114 deletions(-) diff --git a/LINUX.md b/LINUX.md index 1180e4d..753ac02 100644 --- a/LINUX.md +++ b/LINUX.md @@ -93,58 +93,49 @@ Have you signed up to GitHub? If not, [do it right away](https://github.com/join We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate. -- Open your terminal -
- 💡 Windows tip - -We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation -
+ Windows -- Create a SSH key + - We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation. + - Open Windows Terminal + - Run one of the following commands: + - If you're using _Windows PowerShell_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "your_email@example.com" + ``` + - If you're using the classic _Command Prompt_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "your_email@example.com" + ``` -
- Windows -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen.exe -t ed25519 -C "your_email@example.com" -```
MacOS & Linux -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -C "your_email@example.com" -``` + - Open your Terminal + - Run the following command: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" + ```
You should get the following message: `> Generating public/private algorithm key pair.` -- When you are prompted `> Enter a file in which to save the key`, press Enter -- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase. -ℹī¸ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons. +You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase. -- You should be asked to `Enter same passphrase again`, do it. +ℹī¸ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons. -**❗ī¸ You must remember this passphrase.** - -
- ❗ī¸ /home/your_username/.ssh/id_ed25519 already exists. -If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github). +You should be asked to `Enter same passphrase again`, do it. -To create a separate SSH key to exclusively use for this bootcamp use the following: - -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" -``` +**❗ī¸ You must remember this passphrase.** -Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later! -
+Your new SSH Key will be named `de-bootcamp`. ## Google Cloud Platform setup @@ -339,13 +330,19 @@ _Note: The following section requires you already have a [Google Cloud Platform] gcloud-console-add-manual-ssh-key - In your terminal display your public SSH key: - - Windows: navigate to where you created your SSH key and open `id_ed25519.pub` + - Windows: + ```bash + # If you use Windows Terminal + more $HOME\.ssh\de-bootcamp.pub + # OR if you use Command Prompt: + # more %HOMEPATH%\.ssh\de-bootcamp.pub + ``` - Mac/Linux users can use: ```bash - cat ~/.ssh/id_ed25519.pub - # OR cat ~/.ssh/de-bootcamp.pub if you created a unique key + cat ~/.ssh/de-bootcamp.pub ``` + - Copy your public SSH key and paste it: gcloud-console-add-ssh-key-pub @@ -438,7 +435,7 @@ That's the only extension you should install on your _local_ machine, we will in vscode-connect-to-host - Click on `Add a new host` -- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa somedude@34.77.50.76` +- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp somedude@34.77.50.76` vscode-ssh-connection-command diff --git a/WINDOWS.md b/WINDOWS.md index 5dc5f82..65e813b 100644 --- a/WINDOWS.md +++ b/WINDOWS.md @@ -93,58 +93,49 @@ Have you signed up to GitHub? If not, [do it right away](https://github.com/join We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate. -- Open your terminal -
- 💡 Windows tip - -We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation -
+ Windows -- Create a SSH key + - We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation. + - Open Windows Terminal + - Run one of the following commands: + - If you're using _Windows PowerShell_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "your_email@example.com" + ``` + - If you're using the classic _Command Prompt_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "your_email@example.com" + ``` -
- Windows -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen.exe -t ed25519 -C "your_email@example.com" -```
MacOS & Linux -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -C "your_email@example.com" -``` + - Open your Terminal + - Run the following command: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" + ```
You should get the following message: `> Generating public/private algorithm key pair.` -- When you are prompted `> Enter a file in which to save the key`, press Enter -- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase. -ℹī¸ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons. +You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase. -- You should be asked to `Enter same passphrase again`, do it. +ℹī¸ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons. -**❗ī¸ You must remember this passphrase.** - -
- ❗ī¸ /home/your_username/.ssh/id_ed25519 already exists. -If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github). +You should be asked to `Enter same passphrase again`, do it. -To create a separate SSH key to exclusively use for this bootcamp use the following: - -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" -``` +**❗ī¸ You must remember this passphrase.** -Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later! -
+Your new SSH Key will be named `de-bootcamp`. ## Google Cloud Platform setup @@ -339,13 +330,19 @@ _Note: The following section requires you already have a [Google Cloud Platform] gcloud-console-add-manual-ssh-key - In your terminal display your public SSH key: - - Windows: navigate to where you created your SSH key and open `id_ed25519.pub` + - Windows: + ```bash + # If you use Windows Terminal + more $HOME\.ssh\de-bootcamp.pub + # OR if you use Command Prompt: + # more %HOMEPATH%\.ssh\de-bootcamp.pub + ``` - Mac/Linux users can use: ```bash - cat ~/.ssh/id_ed25519.pub - # OR cat ~/.ssh/de-bootcamp.pub if you created a unique key + cat ~/.ssh/de-bootcamp.pub ``` + - Copy your public SSH key and paste it: gcloud-console-add-ssh-key-pub @@ -405,7 +402,7 @@ That's the only extension you should install on your _local_ machine, we will in vscode-connect-to-host - Click on `Add a new host` -- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa somedude@34.77.50.76` +- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp somedude@34.77.50.76` vscode-ssh-connection-command diff --git a/macOS.md b/macOS.md index b233cb2..00010ed 100644 --- a/macOS.md +++ b/macOS.md @@ -93,58 +93,49 @@ Have you signed up to GitHub? If not, [do it right away](https://github.com/join We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate. -- Open your terminal -
- 💡 Windows tip - -We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation -
+ Windows -- Create a SSH key + - We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation. + - Open Windows Terminal + - Run one of the following commands: + - If you're using _Windows PowerShell_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "your_email@example.com" + ``` + - If you're using the classic _Command Prompt_: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "your_email@example.com" + ``` -
- Windows -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen.exe -t ed25519 -C "your_email@example.com" -```
MacOS & Linux -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -C "your_email@example.com" -``` + - Open your Terminal + - Run the following command: + ```bash + # replace "your_email@example.com" with your GCP account email + ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" + ```
You should get the following message: `> Generating public/private algorithm key pair.` -- When you are prompted `> Enter a file in which to save the key`, press Enter -- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase. -ℹī¸ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons. +You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase. -- You should be asked to `Enter same passphrase again`, do it. +ℹī¸ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons. -**❗ī¸ You must remember this passphrase.** - -
- ❗ī¸ /home/your_username/.ssh/id_ed25519 already exists. -If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github). +You should be asked to `Enter same passphrase again`, do it. -To create a separate SSH key to exclusively use for this bootcamp use the following: - -```bash -# replace "your_email@example.com" with your GCP account email -ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com" -``` +**❗ī¸ You must remember this passphrase.** -Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later! -
+Your new SSH Key will be named `de-bootcamp`. ## Google Cloud Platform setup @@ -339,13 +330,19 @@ _Note: The following section requires you already have a [Google Cloud Platform] gcloud-console-add-manual-ssh-key - In your terminal display your public SSH key: - - Windows: navigate to where you created your SSH key and open `id_ed25519.pub` + - Windows: + ```bash + # If you use Windows Terminal + more $HOME\.ssh\de-bootcamp.pub + # OR if you use Command Prompt: + # more %HOMEPATH%\.ssh\de-bootcamp.pub + ``` - Mac/Linux users can use: ```bash - cat ~/.ssh/id_ed25519.pub - # OR cat ~/.ssh/de-bootcamp.pub if you created a unique key + cat ~/.ssh/de-bootcamp.pub ``` + - Copy your public SSH key and paste it: gcloud-console-add-ssh-key-pub @@ -403,7 +400,7 @@ That's the only extension you should install on your _local_ machine, we will in vscode-connect-to-host - Click on `Add a new host` -- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa somedude@34.77.50.76` +- Type `ssh -i @`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp somedude@34.77.50.76` vscode-ssh-connection-command