From a311e52a1c4a6042323d15817cc9ec2a56cbb3b4 Mon Sep 17 00:00:00 2001 From: yoan <536464346@qq.com> Date: Thu, 29 Aug 2024 17:32:08 +0800 Subject: [PATCH] update readme --- README.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 56a92047..a9f67a02 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,20 @@ Certimate 旨在为用户提供一个安全、简便的 SSL 证书管理解决 - [一、安装](#一安装) - [1. 二进制文件](#1-二进制文件) - [2. Docker 安装](#2-docker-安装) - - [二、概念](#二概念) + - [3. 源代码安装](#3-源代码安装) + - [二、使用](#二使用) + - [三、概念](#三概念) - [1. 域名](#1-域名) - [2. dns 服务商授权信息](#2-dns-服务商授权信息) - [3. 部署服务商授权信息](#3-部署服务商授权信息) - - [三、使用](#三使用) - - [许可证](#许可证) + - [四、许可证](#四许可证) ## 一、安装 +安装 Certimate 非常简单,你可以选择以下方式之一进行安装: + ### 1. 二进制文件 你可以直接从[Releases 页](https://github.com/usual2970/certimate/releases)下载预先编译好的二进制文件,解压后执行: @@ -37,6 +40,9 @@ Certimate 旨在为用户提供一个安全、简便的 SSL 证书管理解决 ./certimate serve ``` +> [!NOTE] +> MacOS 在执行二进制文件时会提示:无法打开“certimate”,因为Apple无法检查其是否包含恶意软件。可在系统设置> 隐私与安全性> 安全性 中点击 "仍然允许",然后再次尝试执行二进制文件。 + ### 2. Docker 安装 @@ -46,14 +52,30 @@ git clone git@github.com:usual2970/certimate.git && cd certimate/docker && docke ``` -然后在浏览器中访问 http://127.0.0.1:8090 即可访问 Certimate 管理页面。 +### 3. 源代码安装 + +```bash +git clone EMAIL:usual2970/certimate.git +cd certimate +go run main.go serve +``` + + +## 二、使用 + +执行完上述安装操作后,在浏览器中访问 `http://127.0.0.1:8090` 即可访问 Certimate 管理页面。 ```bash 用户名:admin@certimate.fun 密码:1234567890 ``` -## 二、概念 +![Alt text](usage.gif) + + + + +## 三、概念 Certimate 的工作流程如下: @@ -94,10 +116,8 @@ Certimate 申请证书后,会自动将证书部署到你指定的目标上, 部署服务商授权信息和 dns 服务商授权信息一致,区别在于 dns 服务商授权信息用于证明域名是你的,部署服务商授权信息用于提供证书部署的授权信息。 -## 三、使用 -![Alt text](usage.gif) -## 许可证 +## 四、许可证 Certimate 采用 MIT 许可证,详情请查看 [LICENSE](LICENSE.md) 文件。