gokeyless key server 以容器镜像形式发布,大多数设置可以使用环境变量配置,而不必使用 gokeyless.yaml 文件。
docker pull ghcr.io/cloudflare/gokeyless:latest完整示例可在 gokeyless 仓库的 docker-compose.example.yaml ↗ 中找到。
每个环境变量都映射到 gokeyless.yaml 中的等效设置。两者同时存在时,以环境变量为准(优先级为:命令行标志,然后是环境变量,然后是配置文件)。
| 环境变量 | 用途 |
|---|---|
KEYLESS_HOSTNAME |
此 key server 的主机名(必须与 Cloudflare 中配置的值匹配)。 |
KEYLESS_ZONE_ID |
Cloudflare Zone ID。 |
KEYLESS_ORIGIN_CA_API_KEY |
用于注册 key server 并获取其身份验证证书的 Origin CA API 密钥。 |
KEYLESS_AUTH_CERT |
key server 身份验证证书的路径(默认 server.pem)。 |
KEYLESS_AUTH_KEY |
身份验证证书私钥的路径(默认 server-key.pem)。 |
KEYLESS_AUTH_CSR |
初始化期间写入所生成 CSR 的路径(默认 server.csr)。 |
KEYLESS_CLOUDFLARE_CA_CERT |
用于验证接入 key client 的 Cloudflare CA 证书路径(默认 keyless_cacert.pem)。 |
KEYLESS_PORT |
key server 监听的端口(默认 2407)。 |
KEYLESS_METRICS_PORT |
/metrics 端点的端口(默认 2406)。 |
KEYLESS_LOGLEVEL |
日志详细程度,0(最详细)到 5。 |
私钥位置不能 通过环境变量设置。请在 gokeyless.yaml 中使用 private_key_stores 块进行配置(每条记录恰好设置 dir、file 或 uri 之一),或在镜像名称之后以参数形式传入 --private-key-dirs / --private-key-files 标志(逗号分隔)。
docker run -d \
-e KEYLESS_HOSTNAME=<KEY_SERVER_HOSTNAME> \
-e KEYLESS_ZONE_ID=<ZONE_ID> \
-e KEYLESS_AUTH_CERT=/config/server.pem \
-e KEYLESS_AUTH_KEY=/config/server-key.pem \
-e KEYLESS_CLOUDFLARE_CA_CERT=/config/keyless_cacert.pem \
-v /local/config:/config:ro \
-v /local/keys:/keys:ro \
-p 2407:2407 \
ghcr.io/cloudflare/gokeyless:latest \
--private-key-dirs /keys镜像入口点是 gokeyless,因此任何命令行标志(例如 --private-key-dirs)都追加在镜像名称之后。
单个 key server 可以保存多张证书的私钥。使用 --private-key-dirs / --private-key-files(逗号分隔)列出多个目录或文件,或在 gokeyless.yaml 中定义多条 private_key_stores 记录。