From 56ae5d0fff254aa9a62261d5f8242007d7af4032 Mon Sep 17 00:00:00 2001 From: YANGJINZE Date: Sat, 10 May 2025 10:56:22 +0800 Subject: [PATCH 1/3] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0readme=E9=83=A8?= =?UTF-8?q?=E5=88=86=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 190 ++++++++++++++++++++++++++---------------------------- 1 file changed, 93 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index 83756c8..e7ee445 100644 --- a/README.md +++ b/README.md @@ -1,117 +1,113 @@ -# ALLinSSL - SSL证书全流程管理工具 +# ALLinSSL - SSL证书全流程管理工具 🔒 -## 项目介绍 +![GitHub License](https://img.shields.io/github/license/allinssl/allinssl) +![GitHub Stars](https://img.shields.io/github/stars/allinssl/allinssl?style=social) -ALLinSSL 是一个集证书申请、管理、部署和监控于一体的SSL证书全生命周期管理工具。本工具可帮助用户轻松管理多个网站的SSL证书，提供自动化的证书申请、更新和部署流程，并实时监控证书状态，确保网站安全持续运行。 +

+ 控制台预览 +

-## QQ交流群：768610151 +> 🚀 一站式SSL证书生命周期管理解决方案 | 支持Let's Encrypt | 多平台部署 | 自动化运维 -## 主要功能 +## 📌 项目亮点 +- ✅ 全自动证书申请/续期 +- 🌐 多平台部署（CDN/面板/云存储） +- 🔔 证书过期监控 +- 🛡️ 安全入口保护 +- 📊 可视化证书管理 -- **证书申请**: 支持通过ACME协议从Let's Encrypt等CA自动申请免费证书 -- **证书管理**: 集中管理所有SSL证书，包括手动上传和自动申请的证书 -- **证书部署**: 支持一键部署证书到多种平台，如阿里云、腾讯云、宝塔面板、1Panel等（更多厂商和服务正在支持中） -- **站点监控**: 实时监控站点SSL证书状态，提前预警证书过期 -- **自动化任务**: 支持定时任务，自动续期证书并部署 -- **多平台支持**: 支持多种DNS提供商（阿里云、腾讯云等）的DNS验证方式 - -## 技术栈 - -- **后端**: Go语言 -- **前端**: HTML/CSS/JavaScript -- **数据存储**: SQLite -- **证书管理**: ACME协议 (Let's Encrypt) -- **定时任务**: 内置调度器 - -## 安装说明 +## 🚀 快速开始 ### 系统要求 +- Linux 系统 -- 操作系统: Linux -- 权限要求: 需要有读写权限创建数据目录 - -### 安装步骤 -#### 1. 通过官网安装脚本安装 +### 极速安装 ```bash curl -sSO http://download.allinssl.com/install_allinssl.sh && bash install_allinssl.sh allinssl ``` -#### 2. 编译安装： - - 编译安装时需要注意可执行文件的名称和运行目录，在`allinssl.sh`中需要修改为对应的名称和路径否则可能导致脚本不可用 - - 推荐安装路径为`/www/allinssl/`，可执行文件名为`allinssl`，建议将`allinssl.sh`软链到`/usr/bin/`目录下 - - 安装： - 1. 下载最新版本的release包并解压 - 2. 编译go程序（allinssl） - 3. 运行可执行文件启动服务 - - Linux: 执行 `./allinssl start` -### 首次启动设置 +### 首次配置 +1. 访问 `http://your-server-ip:port/安全入口` +2. 添加DNS提供商和主机提供商凭证 ☁️ +3. 创建工作流 -1. 首次启动后，设置管理员账号和密码 -2. 设置安全入口和端口号 -3. 完成初始设置后，即可通过 `http://your-ip:your-port/your-secure-entry` 访问管理界面 +[完整安装文档](https://allinssl.com/guide/getting-started.html) -## 使用指南 +## 🎯 核心功能 -### 自动化部署 +### 📜 证书管理 +![证书管理流程](https://allinssl.com/images/workflow-edit.png) -#### 证书申请 -1. 添加DNS验证凭证（支持阿里云、腾讯云等） -2. 输入需要申请证书的域名 -3. 输入邮箱地址（用于接收ca的通知） +| 功能 | 支持提供商 | +|--------------|-----------------------------------| +| DNS验证 | 阿里云、腾讯云、Cloudflare... | +| 证书部署 | 宝塔面板、1Panel、阿里云CDN、腾讯云COS | +| 监控通知 | 邮件、Webhook、钉钉 | -#### 证书上传 -1. 选择手动上传证书 -2. 粘贴证书和私钥内容 - -#### 证书部署 - -1. 选择申请或上传的证书 -2. 选择部署目标（支持阿里云CDN/OSS、腾讯云CDN/COS、宝塔面板、1Panel等） -3. 添加部署凭证（如阿里云、腾讯云的API密钥） - -#### 通知 -1. 配置通知通道 -2. 输入通知内容和主题 - - -### 站点监控 - -1. 添加需要监控的站点域名 -2. 系统将自动检测站点证书状态 -3. 设置证书到期提醒阈值（默认为30天） -4. 当证书接近过期时，系统将发出提醒 -5. 连续多次检测网站异常时，系统将发出提醒 - - -## 命令行操作 - -```bash -# 基本操作 -allinssl 1: 启动服务 -allinssl 2: 停止服务 -allinssl 3: 重启服务 -allinssl 4: 修改安全入口 -allinssl 5: 修改用户名 -allinssl 6: 修改密码 -allinssl 7: 修改端口 - -# Web服务管理 -allinssl 8: 关闭web服务 -allinssl 9: 开启web服务 -allinssl 10: 重启web服务 - -# 后台任务管理 -allinssl 11: 关闭后台自动调度 -allinssl 12: 开启后台自动调度 -allinssl 13: 重启后台自动调度 - -# 系统管理 -allinssl 14: 关闭https -allinssl 15: 获取面板地址 -allinssl 16: 更新ALLinSSL到最新版本（文件覆盖安装） -allinssl 17: 卸载ALLinSSL +### ⚙️ 自动化流程 +```mermaid +graph LR +A[证书申请] --> B{有效期监控} +B -->|剩余30天| C[自动续期] +C --> D[部署到目标平台] +D --> E[通知结果] ``` -## 许可证 +## 🛠️ 技术架构 +- **后端**：Go语言 +- **前端**：HTML/CSS/JavaScript +- **数据存储**：SQLite +- **证书管理**：ACME协议 (Let's Encrypt) +- **定时任务**：内置调度器 -本项目使用 [LICENSE](./LICENSE) 文件中规定的许可证进行授权。 +## 📚 使用文档 +- [快速入门指南](https://allinssl.com/guide/getting-started.html) +- [操作手册](https://allinssl.com/features/dashboard.html) + +## 💻 命令行操作 +```bash +# 基本操作 +allinssl 1: 启动服务 🚀 +allinssl 2: 停止服务 ⛔ +allinssl 3: 重启服务 🔄 +allinssl 4: 修改安全入口 🔐 +allinssl 5: 修改用户名 👤 +allinssl 6: 修改密码 🔑 +allinssl 7: 修改端口 🔧 + +# Web服务管理 +allinssl 8: 关闭web服务 🌐➖ +allinssl 9: 开启web服务 🌐➕ +allinssl 10: 重启web服务 🌐🔄 + +# 后台任务管理 +allinssl 11: 关闭后台自动调度 📻⛔ +allinssl 12: 开启后台自动调度 📻✅ +allinssl 13: 重启后台自动调度 📻🔄 + +# 系统管理 +allinssl 14: 关闭https 🔓 +allinssl 15: 获取面板地址 📋 +allinssl 16: 更新ALLinSSL到最新版本（文件覆盖安装） 🔄⬆️ +allinssl 17: 卸载ALLinSSL 🗑️ + +## 🤝 参与贡献 +欢迎通过以下方式参与项目： +1. 提交Issue报告问题 🐛 +2. 发起Pull Request改进代码 💻 +3. 完善项目文档 📖 +4. 分享使用案例 ✨ + +[贡献指南](https://allinssl.com/community/contributing.html) + +## 📞 联系我们 +- QQ交流群：[768610151](https://qm.qq.com/q/KTmWuskjm0) 👥 +- 邮箱：support@allinssl.com 📧 +- 问题反馈：[GitHub Issues](https://github.com/allinssl/allinssl/issues) + +## 📜 许可证 +本项目采用 [AGPL-3.0 license](./LICENSE) 开源协议 + +--- + +> 🌟 **Star本项目以支持开发** | 推荐用于：中小型网站运维、多证书管理场景、自动化HTTPS部署 \ No newline at end of file From 1cf55a9e33314a71fd3d186d2a6aed0cdae6a6f7 Mon Sep 17 00:00:00 2001 From: YANGJINZE Date: Sat, 10 May 2025 10:59:56 +0800 Subject: [PATCH 2/3] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E7=BC=96?= =?UTF-8?q?=E8=AF=91=E5=AE=89=E8=A3=85=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e7ee445..8b39b73 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,15 @@ curl -sSO http://download.allinssl.com/install_allinssl.sh && bash install_allinssl.sh allinssl ``` +### 编译安装 + - 编译安装时需要注意可执行文件的名称和运行目录，在`allinssl.sh`中需要修改为对应的名称和路径否则可能导致脚本不可用 + - 推荐安装路径为`/www/allinssl/`，可执行文件名为`allinssl`，建议将`allinssl.sh`软链到`/usr/bin/`目录下 + - 安装： + 1. 下载最新版本的release包并解压 + 2. 编译go程序（allinssl） + 3. 运行可执行文件启动服务 + - Linux: 执行 `./allinssl start` + ### 首次配置 1. 访问 `http://your-server-ip:port/安全入口` 2. 添加DNS提供商和主机提供商凭证 ☁️ @@ -90,6 +99,7 @@ allinssl 14: 关闭https 🔓 allinssl 15: 获取面板地址 📋 allinssl 16: 更新ALLinSSL到最新版本（文件覆盖安装） 🔄⬆️ allinssl 17: 卸载ALLinSSL 🗑️ +``` ## 🤝 参与贡献 欢迎通过以下方式参与项目： From c4eb466ecce691bafd2f57fcd71ebebb06bb9341 Mon Sep 17 00:00:00 2001 From: YANGJINZE Date: Sat, 10 May 2025 11:07:26 +0800 Subject: [PATCH 3/3] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85docker=E7=BC=96?= =?UTF-8?q?=E8=AF=91=E5=AE=89=E8=A3=85=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8b39b73..98bad25 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,11 @@ curl -sSO http://download.allinssl.com/install_allinssl.sh && bash install_allinssl.sh allinssl ``` +### Docker安装 +```bash +docker run -d --name allinssl -p 7979:8888 -v /www/allinssl/data:/www/allinssl/data allinssl/allinssl:latest +``` + ### 编译安装 - 编译安装时需要注意可执行文件的名称和运行目录，在`allinssl.sh`中需要修改为对应的名称和路径否则可能导致脚本不可用 - 推荐安装路径为`/www/allinssl/`，可执行文件名为`allinssl`，建议将`allinssl.sh`软链到`/usr/bin/`目录下