gluufederation/casa

Gluu Casa Docker镜像文档

概述

Gluu Casa应用的Docker镜像，用于简化Casa服务的部署和运行。Casa是Gluu提供的用户自助服务门户，允许用户管理个人账户设置、认证方式等。

版本

稳定版本请参见https://github.com/GluuFederation/docker-casa/releases%E3%80%82 对于前沿/不稳定版本，使用 gluufederation/casa:4.2.3_dev。

环境变量

容器支持以下环境变量：

• GLUU_CONFIG_ADAPTER：配置后端适配器，可选值为 consul（默认）或 kubernetes。
• GLUU_CONFIG_CONSUL_HOST：Consul的主机名或IP（默认值为 localhost）。
• GLUU_CONFIG_CONSUL_PORT：Consul的端口（默认值为 8500）。
• GLUU_CONFIG_CONSUL_CONSISTENCY：Consul一致性模式（可选值为 default、consistent 或 stale），默认值为 stale 模式。
• GLUU_CONFIG_CONSUL_SCHEME：支持的Consul协议（http 或 https）。
• GLUU_CONFIG_CONSUL_VERIFY：是否验证证书（默认值为 false）。
• GLUU_CONFIG_CONSUL_CACERT_FILE：Consul CA证书文件路径（默认值为 /etc/certs/consul_ca.crt）。如果文件存在且 GLUU_CONFIG_CONSUL_VERIFY 设置为 true，则会使用此文件。
• GLUU_CONFIG_CONSUL_CERT_FILE：Consul证书文件路径（默认值为 /etc/certs/consul_client.crt）。
• GLUU_CONFIG_CONSUL_KEY_FILE：Consul密钥文件路径（默认值为 /etc/certs/consul_client.key）。
• GLUU_CONFIG_CONSUL_TOKEN_FILE：包含ACL令牌的文件路径（默认值为 /etc/certs/consul_token）。
• GLUU_CONFIG_KUBERNETES_NAMESPACE：Kubernetes命名空间（默认值为 default）。
• GLUU_CONFIG_KUBERNETES_CONFIGMAP：Kubernetes配置映射名称（默认值为 gluu）。
• GLUU_CONFIG_KUBERNETES_USE_KUBE_CONFIG：是否从 $HOME/.kube/config 加载凭据，仅在非容器环境中有用（默认值为 false）。
• GLUU_SECRET_ADAPTER：密钥适配器，可选值为 vault 或 kubernetes。
• GLUU_SECRET_VAULT_SCHEME：支持的Vault协议（http 或 https）。
• GLUU_SECRET_VAULT_HOST：Vault的主机名或IP（默认值为 localhost）。
• GLUU_SECRET_VAULT_PORT：Vault的端口（默认值为 8200）。
• GLUU_SECRET_VAULT_VERIFY：是否验证证书（默认值为 false）。
• GLUU_SECRET_VAULT_ROLE_ID_FILE：包含Vault AppRole角色ID的文件路径（默认值为 /etc/certs/vault_role_id）。
• GLUU_SECRET_VAULT_SECRET_ID_FILE：包含Vault AppRole密钥ID的文件路径（默认值为 /etc/certs/vault_secret_id）。
• GLUU_SECRET_VAULT_CERT_FILE：Vault证书文件路径（默认值为 /etc/certs/vault_client.crt）。
• GLUU_SECRET_VAULT_KEY_FILE：Vault密钥文件路径（默认值为 /etc/certs/vault_client.key）。
• GLUU_SECRET_VAULT_CACERT_FILE：Vault CA证书文件路径（默认值为 /etc/certs/vault_ca.crt）。如果文件存在且 GLUU_SECRET_VAULT_VERIFY 设置为 true，则会使用此文件。
• GLUU_SECRET_KUBERNETES_NAMESPACE：Kubernetes命名空间（默认值为 default）。
• GLUU_SECRET_KUBERNETES_CONFIGMAP：Kubernetes密钥名称（默认值为 gluu）。
• GLUU_SECRET_KUBERNETES_USE_KUBE_CONFIG：是否从 $HOME/.kube/config 加载凭据，仅在非容器环境中有用（默认值为 false）。
• GLUU_WAIT_MAX_TIME：启动“健康检查”的最长运行时间（默认值为 300 秒）。
• GLUU_WAIT_SLEEP_DURATION：启动“健康检查”之间的延迟时间（默认值为 10 秒）。
• GLUU_MAX_RAM_PERCENTAGE：传递给Java选项 -XX:MaxRAMPercentage 的值。
• GLUU_PERSISTENCE_TYPE：使用的持久化后端（可选值为 ldap、couchbase 或 hybrid；默认值为 ldap）。
• GLUU_PERSISTENCE_LDAP_MAPPING：指定应存储在LDAP中的数据（可选值为 default、user、cache、site、token 或 session；默认值为 default）。注意：仅当 GLUU_PERSISTENCE_TYPE 设置为 hybrid 时，此环境变量才生效。
• GLUU_LDAP_URL：LDAP服务器的地址和端口（默认值为 localhost:1636）；当 GLUU_PERSISTENCE_TYPE 设置为 ldap 或 hybrid 时为必填项。
• GLUU_COUCHBASE_URL：Couchbase服务器的地址（默认值为 localhost）；当 GLUU_PERSISTENCE_TYPE 设置为 couchbase 或 hybrid 时为必填项。
• GLUU_COUCHBASE_USER：Couchbase服务器的用户名（默认值为 admin）；当 GLUU_PERSISTENCE_TYPE 设置为 couchbase 或 hybrid 时为必填项。
• GLUU_COUCHBASE_CERT_FILE：Couchbase根证书位置（默认值为 /etc/certs/couchbase.crt）；当 GLUU_PERSISTENCE_TYPE 设置为 couchbase 或 hybrid 时为必填项。
• GLUU_COUCHBASE_PASSWORD_FILE：包含Couchbase密码的文件路径（默认值为 /etc/gluu/conf/couchbase_password）；当 GLUU_PERSISTENCE_TYPE 设置为 couchbase 或 hybrid 时为必填项。
• GLUU_COUCHBASE_CONN_TIMEOUT：打开桶时使用的连接超时时间（默认值为 10000 毫秒）。
• GLUU_COUCHBASE_CONN_MAX_WAIT：重试连接前的最长等待时间（默认值为 20000 毫秒）。
• GLUU_COUCHBASE_SCAN_CONSISTENCY：默认扫描一致性；可选值为 not_bounded、request_plus 或 statement_plus（默认值为 not_bounded）。
• GLUU_COUCHBASE_BUCKET_PREFIX：Couchbase桶的前缀（默认值为 gluu）。
• GLUU_COUCHBASE_TRUSTSTORE_ENABLE：为加密的Couchbase连接启用信任存储（默认值为 true）。
• GLUU_COUCHBASE_KEEPALIVE_INTERVAL：Couchbase连接的保活间隔（默认值为 30000 毫秒）。
• GLUU_COUCHBASE_KEEPALIVE_TIMEOUT：Couchbase连接的保活超时时间（默认值为 2500 毫秒）。
• GLUU_OXAUTH_BACKEND：oxAuth后端地址，默认值为 localhost:8081（用于 wait_for.py 脚本）。
• GLUU_OXD_SERVER_URL：oxd服务器的URL（默认值为 https://localhost:8443）。
• GLUU_JAVA_OPTIONS：传递给入口点的Java选项，例如 -Xmx1024m（默认值为空字符串）。
• GLUU_DOCUMENT_STORE_TYPE：文档存储类型（可选值为 LOCAL 或 JCA；默认值为 LOCAL）。
• GLUU_JCA_URL：已弃用，请使用 GLUU_JACKRABBIT_URL。
• GLUU_JACKRABBIT_URL：远程仓库的URL（默认值为 http://localhost:8080）。
• GLUU_JCA_SYNC_INTERVAL：已弃用，请使用 GLUU_JACKRABBIT_SYNC_INTERVAL。
• GLUU_JACKRABBIT_SYNC_INTERVAL：文件同步间隔（默认值为 300 秒）。
• GLUU_JACKRABBIT_ADMIN_ID：管理员用户名（默认值为 admin）。
• GLUU_JACKRABBIT_ADMIN_PASSWORD_FILE：包含管理员用户密码的文件的绝对路径（默认值为 /etc/gluu/conf/jackrabbit_admin_password）。
• GLUU_SSL_CERT_FROM_SECRETS：确定是否从密钥后端获取SSL证书（默认值为 false）。注意：仅当未挂载 /etc/certs/gluu_https.crt 文件时，此标志才生效。