Merge pull request #2 from ICS-25Fall-FDU/doc/ssh

ssh_config

Author: Zecyel

docs/.vitepress/config/zh.ts

@@ -64,6 +64,7 @@ function sidebarGuide(): DefaultTheme.Sidebar {
       text: '附录',
       items: [
         { text: '提问的艺术', link: '/appendix/how-to-ask' },
+        { text: '使用 SSH 连接服务器', link: '/appendix/ssh-server' },
       ]
     },
     {

docs/appendix/remote_explorer.png

@@ -0,0 +1,110 @@
+# 使用 SSH 连接服务器
+
+本文档将帮助使用 macOS 系统的同学完成 SSH 密钥对的生成与配置，并连接到本课程提供的服务器环境进行实验。
+
+## 1. SSH 简介
+
+SSH（Secure Shell）是一种加密的网络传输协议，可以在不安全的网络中为网络服务提供安全的传输环境。通过 SSH，您可以安全地连接到远程服务器并执行命令。
+
+> [!tip]
+>
+> **为什么需要 SSH 密钥？**
+>
+> - **安全性**：相比密码登录，SSH 密钥更加安全
+> - **便利性**：配置完成后无需每次输入密码
+> - **自动化**：支持脚本自动化操作
+
+如果你好奇密钥是如何工作的，可以参考[这篇文章](https://www.ruanyifeng.com/blog/2011/08/what_is_a_digital_signature.html)   。
+
+## 2. 生成 SSH 密钥对
+
+### 检查现有密钥
+
+在生成新密钥之前，先检查是否已经存在 SSH 密钥：
+
+```bash
+# 在终端输入以下命令
+ls -la ~/.ssh
+```
+
+如果目录不存在或为空，说明您还没有 SSH 密钥，可以继续下面的步骤。
+
+> [!tip]
+>
+>如果您有 `id_rsa` 和 `id_rsa.pub` 文件，说明您已经有 SSH 密钥对了。可以移步到配置服务器连接。
+
+### 生成新的密钥对
+
+在终端中输入以下命令生成 SSH 密钥对：
+
+```bash
+# 在终端输入，替换自己的邮箱地址
+ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
+```
+
+执行上述命令后，系统会提示您进行一系列配置：
+
+```bash
+# 连按三个回车即可
+Enter file in which to save the key (/Users/yourusername/.ssh/id_rsa):
+Enter passphrase (empty for no passphrase):
+Enter same passphrase again:
+```
+
+### 验证密钥生成
+
+密钥生成完成后，您可以查看生成的文件：
+
+```bash
+ls -la ~/.ssh
+```
+
+您应该能看到以下文件：
+
+- `id_rsa`：私钥文件（请妥善保管，不要泄露）
+- `id_rsa.pub`：公钥文件（可以安全地分享给服务器）
+
+查看公钥内容：
+
+```bash
+cat ~/.ssh/id_rsa.pub
+```
+
+观察到输出为：`ssh-rsa xxxxxxxxxxxxxxx = xxxxx@xxxx.xx` 即正确
+
+## 3. 使用 VS Code 的 Remote 插件进行远程开发
+
+### 安装 VS Code 插件
+
+   ![remote_explorer](remote_explorer.png)
+
+### 配置文件
+
+- 在左侧找到形如电脑的图标
+- 点击SSH旁边的齿轮
+- 进入默认配置文件
+
+![ssh_config](ssh_config2.png)
+
+### 连接服务器
+
+- 点击SSH旁边的加号，新建远程
+- 在图中所示方框中输入以下命令连接到服务器：
+
+```bash
+ssh root@服务器地址 -p 端口号
+```
+
+![ssh_server](ssh_server2.png)
+
+首次连接时，系统会显示服务器的指纹信息并询问是否信任：
+
+```bash
+The authenticity of host 'xxxxxxx' can't be established.
+ECDSA key fingerprint is SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
+Are you sure you want to continue connecting (yes/no/[fingerprint])?
+```
+
+输入 `yes` 并按回车键继续。
+
+如果配置正确，您应该能够成功登录到服务器而无需输入密码。

docs/appendix/ssh-server.md

@@ -190,17 +190,17 @@ Git 的常用操作可以通过 [Git 学习网站](https://learngitbranching.js.
 
 ### SSH
 
-在 ICS 课程中没有直接使用 SSH 连接服务器的内容，但你可能需要[使用 SSH 连接 GitHub](https://docs.github.com/cn/authentication/connecting-to-github-with-ssh/)。SSH 的完整文档可以通过 man ssh 查阅。
+本课程中，使用 Mac 的同学需要使用 SSH 连接服务器，请参考[这个文档](/appendix/ssh-server)。
 
-如果你从未使用过 SSH，你可能需要为自己创建一个密钥对，参考指令：`ssh-keygen -t ed25519 -C "your_email@example.com"`。密钥对的默认保存位置为 `~/.ssh/`，其中的 `id_rsa` 为私钥，`id_rsa.pub` 为公钥。如果你好奇密钥是如何工作的，可以参考[这篇文章](https://www.ruanyifeng.com/blog/2011/08/what_is_a_digital_signature.html)。
+你可能还需要[使用 SSH 连接 GitHub](https://docs.github.com/cn/authentication/connecting-to-github-with-ssh/)。SSH 的完整文档可以通过 man ssh 查阅。
 
 ### Vim
 
 Vim 的基本用法为运行 `vim something.txt` 打开文件，然后按 `i` 键编辑文件，此时可以直接打字，完成后按 `ESC` 键，输入 `:wq` 保存并退出，或输入 `:q!` 不保存直接退出。
 
 由于 Vim 有一些学习难度，大家当然可以直接选择开箱即用的 VS Code ，但是如果你习惯了 Vim 的操作，用起来就非常爽快。
 
-Vim 的用法非常丰富，如有兴趣可以通过 Vim 自带的教程程序 `vimtutor` 学习（在安装 vim 之后直接在命令行输入这个即可），也可以通过 [Vim 学习网站](https://vim-adventures.com/)学习，或者参考[这个保姆级入门视频](https://www.bilibili.com/video/BV13t4y1t7Wg)。
+Vim 的用法非常丰富，如有兴趣可以通过 Vim 自带的教程程序 `vimtutor` 学习（在安装 Vim 之后直接在命令行输入这个即可），也可以通过 [Vim 学习网站](https://vim-adventures.com/)学习，或者参考[这个保姆级入门视频](https://www.bilibili.com/video/BV13t4y1t7Wg)。
 
 > Copilot 官方提供了一个 [Vim 插件](https://github.com/github/copilot.vim)，可以让你在 Vim 中使用 Copilot。