From e7bbe854388bf5124a06d67e9e311580d5f91e2b Mon Sep 17 00:00:00 2001
From: chn <chn@chn.moe>
Date: Wed, 1 May 2024 12:17:41 +0800
Subject: [PATCH] add doc

---
 .gitattributes   |  1 +
 doc/pageant1.png |  3 +++
 doc/putty1.png   |  3 +++
 doc/putty2.png   |  3 +++
 doc/setup.md     | 38 ++++++++++++++++++++++++++++++++++++++
 doc/winscp1.png  |  3 +++
 doc/winscp2.png  |  3 +++
 7 files changed, 54 insertions(+)
 create mode 100644 .gitattributes
 create mode 100644 doc/pageant1.png
 create mode 100644 doc/putty1.png
 create mode 100644 doc/putty2.png
 create mode 100644 doc/setup.md
 create mode 100644 doc/winscp1.png
 create mode 100644 doc/winscp2.png

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..24a8e87
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text
diff --git a/doc/pageant1.png b/doc/pageant1.png
new file mode 100644
index 0000000..8cee608
--- /dev/null
+++ b/doc/pageant1.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:31a6f2844b602199c9195a2d3782c4aea7bbb9fb088c8d5d52a32641f34943ae
+size 8510
diff --git a/doc/putty1.png b/doc/putty1.png
new file mode 100644
index 0000000..f8f341f
--- /dev/null
+++ b/doc/putty1.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e8c8dbef810866fddee8fede67b46e4cda8f7a8c86cd4bc15334494f8aab086a
+size 127864
diff --git a/doc/putty2.png b/doc/putty2.png
new file mode 100644
index 0000000..4788eba
--- /dev/null
+++ b/doc/putty2.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:61f04294ef1d39ab37454d3ea5510b6d95f93617fca9a38dd2df939e620940a3
+size 98908
diff --git a/doc/setup.md b/doc/setup.md
new file mode 100644
index 0000000..8e7d089
--- /dev/null
+++ b/doc/setup.md
@@ -0,0 +1,38 @@
+为了识别登陆 jykang@hpc.xmu.edu.cn 时使用的密钥，并分密钥统计使用情况，需要启用 SSH agent forwarding。接下来的内容将带领您在 Windows 系统上配置 SSH agent forwarding。
+
+接下来的内容分为三个部分：
+1. 启动 Pageant 并添加密钥。**这一步骤每次登陆前都需要执行。**
+2. 配置 PuTTY，使 PuTTY 在每次登陆时不直接使用密钥，而是利用 Pageant 完成认证。这一步骤只需要执行一次。
+3. 配置 WinSCP，使 WinSCP 在每次登陆时不直接使用密钥，而是利用 Pageant 完成认证。这一步骤只需要执行一次。
+
+**Pageant**:
+
+分为以下几个步骤：
+
+1. 找到 Pageant 程序。Pageant 会随着 PuTTY 一起安装，一般来说您可以直接在开始菜单中搜索 “pageant” 找到它，也可以在 PuTTY 的安装目录中找到它。
+2. 启动 Pageant。启动后可能没有任何反应，也可能有一个黑框闪过，这是正常的。只要右下角的系统托盘中出现了 pageant 的图标就可以了。
+   
+   ![](pageant1.png)
+
+3. 双击 Pageant 图标，打开 Pageant 窗口。选择 “Add Key”，然后选择您的密钥文件。
+4. 在使用服务器期间保持 Pageant 打开（可以关闭 Pageant 的窗口，但不要在系统托盘中右键退出）。
+5. 使用完毕后，在系统托盘中右键退出 Pageant。
+
+**PuTTY**:
+
+1. 在 Connection -> SSH -> Auth，勾选 “Allow agent forwarding“ 并保存。
+   
+   ![Alt text](putty1.png)
+
+2. 在 Connection -> SSH -> Auth -> Credentials，清空 “Private key file for authentication”。
+   
+   ![Alt text](putty2.png)
+
+**WinSCP**:
+
+1. 在 SSH -> Authentication，勾选 “使用 Pageant 进行认证”，勾选 “允许代理转发”，清空 “密钥文件”，然后保存。
+   
+   ![Alt text](winscp1.png)
+2. (选做)如果您需要通过 WinSCP 打开 PuTTY 的话，需要在 WinSCP 主界面 -> 工具 -> 选项 -> 集成 -> 应用程序路径中填入 PuTTY 的路径。
+   
+   ![Alt text](winscp2.png)
diff --git a/doc/winscp1.png b/doc/winscp1.png
new file mode 100644
index 0000000..71692e5
--- /dev/null
+++ b/doc/winscp1.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5632cc423c834462e2dd1557c5467615e0938fb8d4dd1ad97b95d6322957900f
+size 102168
diff --git a/doc/winscp2.png b/doc/winscp2.png
new file mode 100644
index 0000000..ea919e5
--- /dev/null
+++ b/doc/winscp2.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b942d29468330674aba10fbd9bf4cab270108b9ce5bcfae4e81291ce97625e7d
+size 174472