guide配置

您可以使用环境变量配置 CKBox 本地化。下面是可用的环境变量及其描述。

# 密钥

license_key 变量用于验证您是否拥有运行 CKBox 本地化的权利。要获取您的 license_key,请 联系我们。如果您将此选项留空或提供无效的密钥,CKBox 本地化将无法启动。

environments_management_secret_key 变量应该是一个难以猜测的字符串,最好由外部密码生成器生成。它将用于访问 云服务管理面板

# SQL 数据库

# MySQL 数据库

要配置 MySQL 数据库,您应该首先将 database_driver 变量设置为 mysql

然后,您可以提供

  • database_hostdatabase_port 来配置数据库地址。
  • database_userdatabase_password 来配置数据库用户。
  • database_database 来设置 CKBox 本地化应该使用的数据库。

如果您的数据库连接应该被加密,请使用 database_ssl_cadatabase_ssl_keydatabase_ssl_cert 配置。

# Postgres 数据库

要配置 Postgres 数据库而不是 MySQL,您应该首先将 database_driver 变量设置为 postgres

然后,您可以提供

  • database_hostdatabase_port 来配置数据库地址。
  • database_userdatabase_password 来配置数据库用户。
  • database_databasedatabase_schema 来指定本地化服务器应该使用的模式。

如果您的数据库连接应该被加密,请使用 database_ssl_cadatabase_ssl_keydatabase_ssl_cert 配置。

# Redis 数据库

除了 SQL 数据库之外,您还需要使用以下命令配置 Redis 数据库

  • redis_hostredis_port 来配置数据库地址。
  • redis_passwordredis_user 来配置数据库凭据。这两个配置选项都是可选的。

如果不想使用默认的数据库编号(设置为 1),您还可以提供 redis_db

如果您在连接到 IPv6 时遇到问题,请尝试将 redis_ip_family 设置为 6

如果您的数据库连接应该被加密,请使用 redis_tls_caredis_tls_keyredis_tls_cert 配置,或者如果您没有使用自定义证书,则将 redis_tls_enable 设置为 true

# 连接到 Redis 集群

要设置与 Redis 集群的连接,需要将节点提供为 REDIS_CLUSTER_NODES 变量。

REDIS_CLUSTER_NODES        - required (for Redis Cluster connection)
REDIS_IP_FAMILY            - optional (required only when using an IPv6 domain in `REDIS_CLUSTER_NODES`)

REDIS_CLUSTER_NODES 变量需要包含以专用格式的节点列表,该格式由

"IP:PORT:[optional PASSWORD],IP:PORT:[optional PASSWORD]"

要了解连接字符串格式,请查看以下示例

# IPv6
REDIS_CLUSTER_NODES: "[0:0:0:0:0:0:0:1]:7000,[0:0:0:0:0:0:0:1]:7001,[0:0:0:0:0:0:0:1]:7002"

# IPv6 with a password
REDIS_CLUSTER_NODES: "[0:0:0:0:0:0:0:1]:7000:password1,[0:0:0:0:0:0:0:1]:7001:password2,[0:0:0:0:0:0:0:1]:7002:password3"

# Domain name
REDIS_CLUSTER_NODES: "example.redis.server.com:7000,example.redis.server.com:7001,example.redis.server.com:7002"

# Domain name with IPv6 support
REDIS_IP_FAMILY: 6
REDIS_CLUSTER_NODES: "example.ipv6.redis.server.com:7000,example.ipv6.redis.server.com:7001,example.ipv6.redis.server.com:7002"

# Domain name with a password
REDIS_CLUSTER_NODES: "example.redis.server.com:7000:password1,example.redis.server.com:7001:password2,example.redis.server.com:7002:password3"

# 存储

# S3 存储

要配置 S3 作为您的文件存储,您应该首先将 storage_driver 变量设置为 s3

然后,您可以提供

  • storage_access_key_idstorage_secret_access_key 授权服务。
  • storage_bucket 设置存储文件的存储桶。

如果您使用 S3 兼容服务器(如 MinIO),则可以使用 storage_endpoint 变量设置地址。

# Azure Blob 存储

要配置 Azure Blob 存储作为您的文件存储,您应该首先将 storage_driver 变量设置为 azure

然后,您可以提供

  • storage_account_namestorage_account_key 授权服务。
  • storage_container 设置存储文件的容器。

# 文件系统

要配置文件系统作为您的文件存储,您应该首先将 storage_driver 变量设置为 filesystem

然后,您可以使用 storage_location 变量提供要存储文件的目录路径。

# SQL 存储

要配置 MySQL 或 Postgres 作为您的文件存储,您应该将 storage_driver 变量设置为 sql。当使用 SQL 作为存储驱动程序时,应用程序将使用 database_* 变量中提供的配置。