keypub 的安装和配置教程

项目基础介绍

keypub 是一个开源的 SSH 公钥注册表，它将 SSH 公钥与电子邮件地址关联起来，无需管理认证即可连接身份与密钥。keypub.sh 允许用户验证他们拥有的电子邮件地址并将其与 SSH 公钥关联，创建一个专注于用户隐私的可信身份系统。

主要编程语言

该项目主要使用 Go 语言开发，同时也包含 HTML 和 Shell 脚本。

项目使用的关键技术和框架

• SSH 服务器实现：使用 gliderlabs/ssh 库实现 SSH 服务器功能。
• 电子邮件验证：通过 SMTP 或 Resend API 进行电子邮件验证。
• 速率限制：使用 EWMA (指数加权移动平均) 进行请求速率限制。
• 隐私关注的权限系统：确保用户的隐私和数据安全。

准备工作

在开始安装 keypub 之前，请确保您的系统中已经安装了以下依赖：

• Go 语言环境（推荐版本 go1.15 或更高）
• Git 版本控制系统

安装步骤

1. 克隆项目

   首先，使用 Git 克隆项目到本地目录：

   git clone https://github.com/skariel/keypub.git
   cd keypub
   

2. 安装依赖

   在项目目录中，使用 Go 工具安装所需的依赖：

   go mod tidy
   

3. 配置项目

   在 config.json.example 文件中配置您的项目设置，并将其重命名为 config.json：

   cp config.json.example config.json
   

   根据您的需要编辑配置文件，包括数据库连接信息等。

4. 启动 SSH 服务器

   使用以下命令启动 SSH 服务器：

   go run cmd ssh_server/main.go
   

5. 注册和验证您的 SSH 密钥

   按照项目的 Quick Start 指南注册和验证您的 SSH 密钥：

   • 注册您的 SSH 密钥与电子邮件：

     ssh keypub.sh register [e-mail]
     

   • 使用收到的验证码确认您的电子邮件：

     ssh keypub.sh confirm VERIFICATION-CODE
     

   • (可选) 创建别名以便于使用：

     alias kp='ssh keypub.sh'
     

完成以上步骤后，您的 keypub 应该已经成功安装并配置完毕，可以开始使用了。