diff --git a/README.md b/README.md index 709da1a7..59eab017 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Certd 是一个免费全自动申请和自动部署更新SSL证书的管理系 > 关于证书续期: >* 实际上没有办法不改变证书文件本身情况下直接续期或者续签。 >* 我们所说的续期,其实就是按照全套流程重新申请一份新证书,然后重新部署上去。 - + >* 免费证书过期时间90天,以后可能还会缩短,所以自动化部署必不可少 ## 二、在线体验 @@ -65,7 +65,7 @@ https://certd.handfree.work/ -------> [点我查看详细使用步骤演示](./step.md) <-------- ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ -更多教程请访问文档网站 [certd.docmirror.cn](https://certd.docmirror.cn/) +更多教程请访问官方文档 [certd.docmirror.cn](https://certd.docmirror.cn/) @@ -75,10 +75,10 @@ https://certd.handfree.work/ 您可以根据实际情况从如下方式中选择一种方式进行私有化部署: -1. [宝塔面板方式部署](https://certd.docmirror.cn/guide/install/docker/) -2. [1Panel面板方式部署](https://certd.docmirror.cn/guide/install/1panel/) -3. [Docker方式部署](https://certd.docmirror.cn/guide/install/docker/) -4. [源码方式部署](https://certd.docmirror.cn/guide/install/source/) +1. [宝塔面板方式部署 推荐](https://certd.docmirror.cn/guide/install/docker/) +2. [1Panel面板方式部署 推荐](https://certd.docmirror.cn/guide/install/1panel/) +3. [Docker方式部署 推荐](https://certd.docmirror.cn/guide/install/docker/) +4. [源码方式部署 不建议](https://certd.docmirror.cn/guide/install/source/) #### Docker镜像说明: * 国内镜像地址: @@ -104,86 +104,20 @@ https://certd.handfree.work/ > * 请务必做好服务器本身的安全防护,防止数据库泄露 > * 请务必做好数据备份,避免数据丢失 -## 五、 升级 - -### docker-compose方式部署 -#### 1. 如果使用固定版本号 -1. 修改`docker-compose.yaml`中的镜像版本号 -2. 运行`docker compose up -d` 即可 - -#### 2. 如果需要使用最新版本 -```shell -#重新拉取镜像 -docker pull registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest -# 重新启动容器 -docker compose down -docker compose up -d -``` -> 数据默认存在`/data/certd`目录下,不用担心数据丢失 - -### 自动升级(仅限尝鲜建议非生产使用) -```yaml -version: '3.3' -services: - certd: - image: registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest - container_name: certd - restart: unless-stopped - volumes: - - /data/certd:/app/data - ports: - - "7001:7001" - - "7002:7002" - environment: - - certd_system_resetAdminPasswd=false - labels: - com.centurylinklabs.watchtower.enable: "true" - - certd-updater: # 添加 Watchtower 服务 - image: containrrr/watchtower:latest - container_name: certd-updater - restart: unless-stopped - volumes: - - /var/run/docker.sock:/var/run/docker.sock - # 配置 自动更新 - environment: - - WATCHTOWER_CLEANUP=true # 自动清理旧版本容器 - - WATCHTOWER_INCLUDE_STOPPED=false # 不更新已停止的容器 - - WATCHTOWER_LABEL_ENABLE=true # 根据容器标签进行更新 - - WATCHTOWER_POLL_INTERVAL=300 # 每 5 分钟检查一次更新 - -``` - -### 其他部署方式升级方法 -请参考 https://certd.docmirror.cn/guide/install/upgrade.html -### 更新日志: +## 五、更多帮助 +请访问官方文档:[https://certd.docmirror.cn/](https://certd.docmirror.cn/) -[CHANGELOG](./CHANGELOG.md) +* 升级方法:[升级方法](https://certd.docmirror.cn/guide/install/upgrade/) +* 常见问题:[忘记密码](https://certd.docmirror.cn/guide/use/forgotpasswd/) +* 多数据库:[多数据库配置](https://certd.docmirror.cn/guide/install/database/) +* 站点安全:[站点安全特性](https://certd.docmirror.cn/guide/feature/safe/) +* 更新日志:[CHANGELOG](./CHANGELOG.md) -## 六、一些说明 -* 本项目ssl证书提供商为letencrypt/Google/ZeroSSL -* 申请过程遵循acme协议 -* 证书续期: - * 实际上没有办法不改变证书文件本身情况下直接续期或者续签。 - * 我们所说的续期,其实就是按照全套流程重新申请一份新证书,然后重新部署上去。 -* 免费证书过期时间90天,以后可能还会缩短,所以自动化部署必不可少 -* 设置每天自动运行,当证书过期前35天,会自动重新申请证书并部署 - - -## 七、不同平台的设置说明 - -* 已迁移到新的文档网站,请到常见问题章节查看 -* [最新文档站链接 https://certd.docmirror.cn](https://certd.docmirror.cn/) - -## 八、问题处理 -### 7.1 忘记管理员密码 -[重置管理员密码方法](https://certd.docmirror.cn/guide/use/forgotpasswd/) - -## 九、联系作者 +## 六、联系作者 如有疑问,欢迎加入群聊(请备注certd) | 加群 | 微信群 | QQ群 | @@ -197,7 +131,7 @@ services: | 二维码 | | -## 十、捐赠 +## 七、捐赠 ************************ 支持开源,为爱发电,我已入驻爱发电 https://afdian.com/a/greper @@ -221,34 +155,26 @@ https://afdian.com/a/greper ************************ -## 十一、贡献代码 +## 八、贡献代码 -1. 本地开发 [贡献插件](https://certd.docmirror.cn/guide/development/) +1. 本地开发请参考 [贡献插件向导](https://certd.docmirror.cn/guide/development/) 2. 作为贡献者,代表您同意您贡献的代码如下许可: 1. 可以调整开源协议以使其更严格或更宽松。 2. 可以用于商业用途。 -## 十二、 开源许可 +## 九、 开源许可 * 本项目遵循 GNU Affero General Public License(AGPL)开源协议。 * 允许个人和公司内部自由使用、复制、修改和分发本项目,未获得商业授权情况下禁止任何形式的商业用途 * 未获得商业授权情况下,禁止任何对logo、版权信息及授权许可相关代码的修改。 * 如需商业授权,请联系作者。 -## 十三、我的其他项目(求Star) +## 十、我的其他项目(求Star) | 项目名称 | stars | 项目描述 | |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------|-----------------------------------| | [袖手AI](https://ai.handsfree.work/) | | 袖手GPT,国内可用,无需FQ,每日免费额度 | | [fast-crud](https://gitee.com/fast-crud/fast-crud/) | GitHub stars | 基于vue3的crud快速开发框架 | | [dev-sidecar](https://github.com/docmirror/dev-sidecar/) | GitHub stars | 直连访问github工具,无需FQ,解决github无法访问的问题 | - - - -## 十四、更新日志 - -更新日志:[CHANGELOG](./CHANGELOG.md) - -