开源项目 `certify` 使用教程

1. 项目的目录结构及介绍

certify 项目的目录结构如下：

certify/
├── cmd/
│   └── certify/
│       └── main.go
├── examples/
│   └── simple/
│       └── main.go
├── internal/
│   ├── acme/
│   ├── cert/
│   ├── client/
│   ├── config/
│   ├── issuer/
│   ├── provider/
│   └── storage/
├── pkg/
│   ├── acme/
│   ├── cert/
│   ├── client/
│   ├── config/
│   ├── issuer/
│   ├── provider/
│   └── storage/
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件。
• examples/: 包含示例代码。
• internal/: 包含项目的内部实现代码。
• pkg/: 包含项目的公共库代码。
• .gitignore: Git 忽略文件。
• go.mod 和 go.sum: Go 模块文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/certify/main.go。该文件主要负责初始化配置和启动服务。

package main

import (
    "log"
    "os"

    "github.com/johanbrandhorst/certify"
    "github.com/johanbrandhorst/certify/issuers/vault"
)

func main() {
    // 初始化配置
    config := &certify.Config{
        CommonName: "example.com",
    }

    // 创建证书颁发者
    issuer := &vault.Issuer{
        URL: "https://vault.example.com",
    }

    // 创建证书管理器
    cm := certify.NewCertify(config, issuer)

    // 启动服务
    if err := cm.ListenAndServeTLS("", ""); err != nil {
        log.Fatalf("Failed to start server: %v", err)
    }
}

启动文件介绍

• main.go: 主程序入口，负责初始化配置、创建证书颁发者和证书管理器，并启动服务。

3. 项目的配置文件介绍

certify 项目的配置主要通过代码中的 certify.Config 结构体进行设置。以下是一个示例配置：

config := &certify.Config{
    CommonName: "example.com",
    DNSNames:   []string{"example.com", "www.example.com"},
    IPAddresses: []net.IP{
        net.ParseIP("127.0.0.1"),
    },
    RenewBefore: 24 * time.Hour,
    Cache:       certify.DirCache("certs"),
}

配置文件介绍

• CommonName: 证书的通用名称。
• DNSNames: 证书的 DNS 名称列表。
• IPAddresses: 证书的 IP 地址列表。
• RenewBefore: 证书续订前的提前时间。
• Cache: 证书缓存目录。

以上是 certify 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。