ZITADEL 开源项目安装与使用指南

目录结构及介绍

在克隆 ZITADEL 的仓库之后, 你可以看到以下主要目录:

• cmd/: 包含了启动和管理 ZITADEL 实例的命令行工具.

  • cmd/zitadel/main.go: 主要启动入口点.

• internal/: 这个目录包含了 ZITADEL 内部组件和业务逻辑相关的代码. 不建议外部开发者修改此部分代码以避免破坏系统稳定性.

• pkg/: 此目录下的代码主要用于处理应用程序级别的包和功能如数据库操作权限管理等.

• plugins/: 插件开发所需的代码可以在这里找到.

• templates/: 包括HTML和相关模板, 主要用于前端页面渲染.

• .docker/: 包含了用于构建 Docker 镜像的 Dockerfile 和其他相关文件.

• docs/: 文档和指南存放处.

项目的启动文件介绍

主要的启动文件是位于 cmd/zitadel 下的 main.go. 它负责读取配置文件并初始化所有依赖的服务(例如数据库连接), 然后启动 HTTP 和 gRPC 服务器, 最终使 ZITADEL 能够接受来自客户端的请求.

为了运行 main.go, 首先确保你已经安装好了 Go 环境. 接下来执行以下步骤:

1. 切换到包含 main.go 的目录。
2. 使用下面的命令进行构建并执行应用:

   GOOS=linux GOARCH=amd64 go build ./cmd/zitadel/
   

这将创建一个可执行文件 zitadel, 可以用来启动服务. 在终端中输入下面命令来启动 ZITADEL:

./zitadel serve --config config.yaml

这里的 --config 参数指定了配置文件路径, 更多配置项详情见下文.

项目的配置文件介绍

配置文件 config.yaml 是 Yaml 格式, 存储着各种运行时参数和环境变量设置. 典型的 config.yaml 文件可能包括以下几部分:

基本配置:

listen:
  address: ":443" 
  protocol: "tls"
database:
  dialect: "postgres"
  connection_string: "host=localhost port=5432 user=myuser dbname=mydb sslmode=disable"

这里我们定义了ZITADEL监听端口地址以及使用的 TLS 加密协议; 数据库连接信息被保存在数据库部分, 我们指明了方言(dialect)是 postgres 并提供了相应的连接字符串.

认证与授权:

auth:
  secret_key: "your_secret_key_here"
  issuer: "http://localhost:443"
oauth2:
  clients:
    - id: "client_id"
      secret: "client_secret"

认证部分通常存储与会话管理和安全令牌相关的数据, 而OAuth2部分则记录了客户端 ID 和秘密, 对应于第三方服务集成.

日志与监控:

logging:
  level: "info"
metrics:
  prometheus_listen_address: ":9090"

这些选项控制了日志级别以及 Prometheus 度量指标收集器绑定的地址.

插件与扩展性:

plugins:
  enabled: true
  directory: "./plugins"

这个部分包含了插件是否启用的信息以及插件的位置信息.

通过阅读和编辑 config.yaml, 用户可以根据实际部署需求来调整各个模块的行为和性能特性. 若要深入了解具体参数意义, 请参考项目官方文档中的详细说明.