From 4af45ac9e9856886b568848954cffa5d8c8c16b6 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 8 Aug 2025 08:19:50 +0000 Subject: [PATCH] Update README.md --- README.en.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 170 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d7aad73 --- /dev/null +++ b/README.en.md @@ -0,0 +1,83 @@ + + +# VK Certificate Deployment Notification System + +This is a lightweight system for handling SSL certificate deployment notifications, enabling automatic certificate deployment, domain configuration, validation, and other functions through cloud interaction. + +## Features + +- Supports automatic SSL certificate deployment notifications +- Provides domain configuration and verification capabilities +- Integrates with Alibaba Cloud UniCloud +- Offers encryption and decryption features to ensure secure data transmission +- Supports Token retrieval and setting for user login and authentication + +## Directory Structure + +``` +├── App.vue # Root component of the application +├── index.html # Entry HTML file +├── main.js # Application entry file, creates the Vue instance +├── manifest.json # Application configuration manifest file +├── pages.json # Page configuration file +├── uni.promisify.adaptor.js # UniApp adapter file +├── uni.scss # Global style file +├── static/logo.png # Static resource image +├── pages/ +│ └── index/ +│ └── index.vue # Home page component +└── uniCloud-aliyun/ + └── cloudfunctions/ + └── vk-cert-deploy-notice/ + ├── config.js # Configuration file + ├── index.js # Cloud function entry file + ├── package.json # Cloud function dependency configuration file + └── sdk.js # Main SDK logic file +``` + +## Main Module Description + +- **sdk.js**: Contains the core functionality of the system, including: + - `encrypt(e)` and `decrypt(e)`: Encryption and decryption methods + - `certDeploy(e={})`: Deploys an SSL certificate + - `createDomainWithCert(e)`: Creates a domain with an associated certificate + - `domainVerifyContent(e)`: Verifies domain content + - `listSpace(e={})`, `listWebDomain(e={})`, `listHttpDomain(e={})`: Lists spaces and domains + - `getToken()`, `setToken(e,t)`, `login()`: Token management and user login + +## Installation and Usage + +### Installation + +1. Clone the project: + ```bash + git clone https://gitee.com/free-ssl-cert/vk-cert-deploy-notice.git + ``` + +2. Navigate to the project directory: + ```bash + cd vk-cert-deploy-notice + ``` + +3. Install dependencies: + ```bash + npm install + ``` + +### Usage + +1. Configure the Alibaba Cloud function in the UniCloud environment. +2. Modify the relevant configurations in `config.js`. +3. Deploy the cloud function and invoke methods in the SDK to handle certificate deployment and domain management. + +## Open Source License + +This project is licensed under the MIT License. For details, please refer to the [LICENSE](LICENSE) file. + +## Contribution + +We welcome you to submit Issues and Pull Requests to help improve and refine the project. + +## Contact + +To get in touch with the author, please send a message through the [Gitee](https://gitee.com/free-ssl-cert) platform. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d3825ad --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ + + +README.md 内容如下： + +--- + +# VK证书部署通知系统 + +这是一个用于处理 SSL 证书部署通知的轻量级系统，通过与云端交互实现证书的自动部署、域名配置及验证等功能。 + +## 功能特点 + +- 支持 SSL 证书的自动部署通知 +- 提供域名配置和验证功能 +- 支持与阿里云 UniCloud 的集成 +- 提供加密与解密功能以保障数据传输安全 +- 支持获取和设置 Token，进行用户登录和身份验证 + +## 目录结构 + +``` +├── App.vue # 应用的根组件 +├── index.html # 入口 HTML 文件 +├── main.js # 应用入口文件，创建 Vue 实例 +├── manifest.json # 应用的配置清单文件 +├── pages.json # 页面配置文件 +├── uni.promisify.adaptor.js # 用于 UniApp 的适配器文件 +├── uni.scss # 全局样式文件 +├── static/logo.png # 静态资源图片 +├── pages/ +│ └── index/ +│ └── index.vue # 首页页面组件 +└── uniCloud-aliyun/ + └── cloudfunctions/ + └── vk-cert-deploy-notice/ + ├── config.js # 配置文件 + ├── index.js # 云函数入口文件 + ├── package.json # 云函数依赖配置文件 + └── sdk.js # SDK 主要逻辑文件 +``` + +## 主要模块说明 + +- **sdk.js**：包含系统核心功能，如： + - `encrypt(e)` 和 `decrypt(e)`：加密与解密方法 + - `certDeploy(e={})`：部署 SSL 证书 + - `createDomainWithCert(e)`：创建带证书的域名 + - `domainVerifyContent(e)`：验证域名内容 + - `listSpace(e={})`、`listWebDomain(e={})`、`listHttpDomain(e={})`：列出空间及域名 + - `getToken()`、`setToken(e,t)`、`login()`：Token 管理与用户登录 + +## 安装与使用 + +### 安装 + +1. 克隆项目： + ```bash + git clone https://gitee.com/free-ssl-cert/vk-cert-deploy-notice.git + ``` + +2. 进入项目目录： + ```bash + cd vk-cert-deploy-notice + ``` + +3. 安装依赖： + ```bash + npm install + ``` + +### 使用 + +1. 在 UniCloud 环境中配置阿里云函数。 +2. 修改 `config.js` 中的相关配置。 +3. 部署云函数并调用 SDK 中的方法处理证书部署和域名管理。 + +## 开源协议 + +本项目采用 MIT 协议，详情请查看 [LICENSE](LICENSE) 文件。 + +## 贡献 + +欢迎提交 Issue 和 Pull Request，帮助我们改进和完善项目。 + +## 联系方式 + +如需联系作者，请通过 [Gitee](https://gitee.com/free-ssl-cert) 平台提交消息。 \ No newline at end of file -- Gitee