生产部署

# usip about
USIP_ENABLED=true  # 设置为 true 以启用 USIP
USIP_URI_CREDENTIAL=https://your-domain/usip/credential
USIP_URI_USERINFO=https://your-domain/usip/userinfo
USIP_URI_ROLE=https://your-domain/usip/role
USIP_URI_COLLABORATORS=https://your-domain/usip/collaborators
  
# auth about
AUTH_PERMISSION_ENABLE_OBJ_INHERIT=false
AUTH_PERMISSION_CUSTOMER_STRATEGIES=

universer:
  config:
    usip:
      enabled: true  # 设置为 true 以启用 USIP
      uri:
        userinfo: "https://your-domain/usip/userinfo"
        collaborators: "https://your-domain/usip/collaborators"
        role: "https://your-domain/usip/role"
        credential: "https://your-domain/usip/credential"
    auth:
      permission:
        enableObjInherit: false
        customerStrategies: ""

EVENT_SYNC=true  # 设置 true 为开启

universer:
  config:
    rabbitmq:
      eventSync: true  # 设置 true 为开启

# RDS config
DISABLE_UNIVER_RDS=true  # 使用自己的 RDS 时，需要设置禁止 Univer 部署默认的 postgresql
  
DATABASE_DRIVER=postgresql  # 设置为 postgresql 代表使用兼容 postgresql 的数据库
DATABASE_HOST=your-database-host
DATABASE_PORT=your-database-port
DATABASE_DBNAME=univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
DATABASE_USERNAME=user-name  # 你应该给此 user 授予 select、insert、update、delete 权限
DATABASE_PASSWORD=password

postgresql:
  enabled: false  # 禁止 Univer 部署自带的数据库
 
universer:
  config:
    database:
      driver: postgresql  # 设置为 postgresql 代表使用兼容 postgresql 的数据库
      host: your-database-host
      port: your-database-port
      dbname: univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
      username: postgres  # 你应该给此 user 授予 select、insert、update、delete 权限
      password: postgres
 
temporal:  # temporal 用到了数据库
  server:
    config:
      persistence:
        default:
          driver: "sql"  # 固定设置为 sql
          sql:
            driver: "postgres12"  # postgres 需要 12 以上的版本
            host: your-database-host
            port: your-database-port
            database: temporal  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
            user: postgres  # 你应该给此 user 授予 select、insert、update、delete 权限
            password: postgres
 
        visibility:
          driver: "sql"
          sql:
            driver: "postgres12"  # postgres 需要 12 以上的版本
            host: your-database-host
            port: your-database-port
            database: temporal_visibility  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
            user: postgres  # 你应该给此 user 授予 select、insert、update、delete 权限
            password: postgres

# RDS config
DISABLE_UNIVER_RDS=true  # 使用自己的 RDS 时，需要设置禁止 Univer 部署默认的 postgresql
  
DATABASE_DRIVER=mysql  # 设置为 mysql 代表使用兼容 mysql 的数据库
DATABASE_HOST=your-database-host
DATABASE_PORT=your-database-port
DATABASE_DBNAME=univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
DATABASE_USERNAME=user-name  # 你应该给此 user 授予 select、insert、update、delete 权限
DATABASE_PASSWORD=password

postgresql:
  enabled: false  # 禁止 Univer 部署自带的数据库
 
universer:
  config:
    database:
      driver: mysql  # 设置为 mysql 代表使用兼容 mysql 的数据库
      host: your-database-host
      port: your-database-port
      dbname: univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
      username: mysql  # 你应该给此 user 授予 select、insert、update、delete 权限
      password: mysql
 
temporal:
  server:
    config:
      persistence:
        default:
          driver: "sql"
          sql:
            driver: "mysql8"  # 我们要求的 mysql 版本为 8.x
            host: your-database-host
            port: your-database-port
            database: temporal  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
            user: mysql  # 你应该给此 user 授予 select、insert、update、delete 权限
            password: mysql
 
        visibility:
          driver: "sql"
          sql:
            driver: "mysql8"
            host: your-database-host
            port: your-database-port
            database: temporal_visibility  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
            user: mysql
            password: mysql

# RDS config
DISABLE_UNIVER_RDS=true  # 使用自己的 RDS 时，需要设置禁止 Univer 部署默认的 postgresql
  
DATABASE_DRIVER=gaussdb
DATABASE_HOST=your-database-host
DATABASE_PORT=your-database-port
DATABASE_DBNAME=univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
DATABASE_USERNAME=user-name  # 你应该给此 user 授予 select、insert、update、delete 权限
DATABASE_PASSWORD=password

universer:
  config:
    database:
      driver: gaussdb
      host: your-database-host
      port: your-database-port
      dbname: univer  # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
      username: gaussdb  # 你应该给此 user 授予 select、insert、update、delete 权限
      password: gaussdb

# RDS config
DISABLE_UNIVER_RDS=true  # 使用自己的 RDS 时，需要设置禁止 Univer 部署默认的 postgresql
  
DATABASE_DRIVER=dameng
DATABASE_HOST=your-database-host
DATABASE_PORT=your-database-port
DATABASE_DBNAME=univer # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
DATABASE_USERNAME=user-name # 你应该给此 user 授予 select、insert、update、delete 权限
DATABASE_PASSWORD=password

universer:
  config:
    database:
      driver: dameng
      host: your-database-host
      port: your-database-port
      dbname: univer # Univer 的数据库初始化脚本默认使用的是这个名字，如果你有更改，请更新这里保持一致
      username: dameng # 你应该给此 user 授予 select、insert、update、delete 权限
      password: dameng

# redis config
DISABLE_UNIVER_REDIS=true # 使用自己的 redis 时，需要禁止 Univer 安装内建的 redis
  
# if you use redis cluster, use comma ',' to separate multiple addresses
# for example: REDIS_ADDR=192.168.1.5:6001,192.168.1.5:6002,192.168.1.5:6003
REDIS_ADDR=host:port[,host:port]
REDIS_USERNAME=user-name
REDIS_PASSWORD=password
REDIS_DB=0

universer:
  config:
    redis:
      poolSize: 100
      # 如果是 redis 集群，可以用逗分隔多个地址
      # 例如：192.168.1.100:6379,192.168.1.101:6379
      addr: 192.168.1.100:6379
      read_timeout: 1s
      write_timeout: 1s
      db: 0
      username: user_name_here
      password: password_here
 
redis:
  enabled: false  # 禁止 Univer 部署自带的 redis

DISABLE_UNIVER_MQ=true  # 使用自己的 MQ 时，需要禁止 Univer 安装内置的 MQ
  
RABBITMQ_CLUSTER_ENABLED=true  # 必须设置为 true
RABBITMQ_CLUSTER_USERNAME=user-name # 有权限的账户，需要 Declear Exchange、Produce、Consume 权限
RABBITMQ_CLUSTER_PASSWORD=password  # password
  
# use comma to separate multiple addresses
# for example: RABBITMQ_CLUSTER_ADDR=192.168.1.2:5672,192.168.1.5:5672,192.168.1.7:5672
# 每个 addr 都要能读写，Univer 在连接时会轮询其中的 host，直到连接成功
RABBITMQ_CLUSTER_ADDR=host:port[,host:port]
  
# RABBITMQ_CLUSTER_VHOST is the vhost of the rabbitmq cluster. If you don't set it, the default value is /
# for example: RABBITMQ_CLUSTER_VHOST=univer
RABBITMQ_CLUSTER_VHOST=/
RABBITMQ_CLUSTER_SCHEMA=amqp

universer:
  config:
    rabbitmq:
      cluster:
        enabled: true  # 必须设置为 true
        # use comma to separate multiple addresses
        # for example: RABBITMQ_CLUSTER_ADDR=192.168.1.2:5672,192.168.1.5:5672
        # 每个 addr 都要能读写，Univer 在连接时会轮询其中的 host，直到连接成功
        addr: "192.168.1.2:5672,192.168.1.5:5672"
        username: "user-here"
        password: "password-here"
        vhost: "/"
        schema: amqp
 
rabbitmq:
  enabled: false  # 禁止 Univer 部署自带的 rabbitmq

DISABLE_UNIVER_S3=true  # 使用自己的 object storage 时，需要禁止 Univer 安装内建的 minio
  
# s3 config
S3_USER=user
S3_PASSWORD=password
S3_REGION=your-inner-s3like-region  # 如果你的 S3-like 没有这个概念，随意填写个字符串即可
  
# S3_PATH_STYLE，可设置true或false
# 如果设置为 true，使用路径样式（Path-Style）来构建访问 URL
# 如果设置为false，使用虚拟主机样式（Virtual-Host Style）来构建访问 URL
S3_PATH_STYLE=true|false
  
# S3_ENDPOINT 提供给内部服务访问的地址
S3_ENDPOINT=inner-visit-host:port
  
# S3_ENDPOINT_PUBLIC 公开访问的地址，在客户端直接连接对象存储下载文件时使用
S3_ENDPOINT_PUBLIC=public-visit-host:port
  
# S3_DEFAULT_BUCKET 配置使用哪个 bucket
S3_DEFAULT_BUCKET=default-bucket-name

universer:
  config:
    s3:
      accessKeyID: admin
      accessKeySecret: minioadmin
      region: "us-east-1"
      endpoint: http://192.168.1.100:9000
      endpointPublic: http://192.168.1.100:9001
      usePathStyle: true
      defaultBucket: univer
 
minio:
  enabled: false  # 禁止 Univer 部署自带的 minio

# observability config
ENABLE_UNIVER_OBSERVABILITY=true  # 设置为 true 则开启
GRAFANA_USERNAME=set-your-admin-user-name-here  # 设置好 grafana 的管理员账号
GRAFANA_PASSWORD=set-your-admin-user-password-here  # 设置好 grafana 的管理员密码
HOST_GRAFANA_PORT=set-the-port-you-want  # grafana 对外暴露端口

UNIVERSER_REPLICATION_CNT=2  # universer 实例数
COLLABORATION_SERVER_REPLICATION_CNT=2  # 协同服务实例数
COLLABORATION_SERVER_MEMORY_LIMIT=2048  # 配置协同服务的最大内存限制，单位为 MB
 
# 导入导出 exchange-worker 容量相关配置
EXCHANGE_WORKER_REPLICATION_CNT=1 # working exchange worker count
EXCHANGE_WORKER_MEMORY_LIMIT=4096 # MB, the memory limit of each exchange-worker.
EXCHANGE_WORKER_IMPORT_CONCURRENT=1 # how many import tasks each worker can do at the same time.
EXCHANGE_WORKER_EXPORT_CONCURRENT=1 # how many export tasks each worker can do at the same time.

universer:
  replicaCount: 3  # universer 实例数
collaboration-server:
  replicaCount: 3  # 协同服务实例数
  maxMemoryLimit: 2048 # MB, 配置协同服务的最大内存限制
worker:
  replicaCount: 1 # working exchange worker count
  temporalWorker:
    importConcurrent: 1 # how many import tasks each worker can do at the same time.
    exportConcurrent: 1 # how many export tasks each worker can do at the same time.

# 如果和你们的网络配置存在冲突，可以修改 docker 使用的网段。使用 CIDR 表示法
DOCKER_NETWORK_SUBNET=172.30.0.0/16
  
# Univer API 服务暴露的端口，如果和你宿主机的其他服务端口重复，请更换成其他端口
HOST_NGINX_PORT=the-univer-server-api-port-you-wantted
  
# 如果你选择了 Univer 安装包内置的 minio 作为对象存储，且存在端口冲突，请添加此配置项修改
# 当然，如果你使用的是自己维护的对象存储，设置此配置项将无任何意义
HOST_MINIO_PORT=the-minio-port-you-wantted
  
# 如果你选择了 Univer 安装包内置的可观测组件，且存在端口冲突，请添加此配置项修改
# 当然，如果你使用的是自己维护的可观测组件，设置此配置项将无任何意义
HOST_GRAFANA_PORT=the-grafana-port-you-wantted

# allowed cross-origins config
CORS_ALLOW_ORIGINS=["domain1", "domain2", "and more"]

universer:
  config:
    server:
      http:
        corsAllowOrigins: ["domain1", "domain2", "and more"]

# 1. enable USIP integration
# usip about
USIP_ENABLED=true
USIP_URI_CREDENTIAL=https://usip-demo.univer.ai/usip/credential
USIP_URI_USERINFO=https://usip-demo.univer.ai/usip/userinfo
USIP_URI_ROLE=https://usip-demo.univer.ai/usip/role
USIP_URI_COLLABORATORS=https://usip-demo.univer.ai/usip/collaborators
      
# 2. only owner can copy content and print
AUTH_PERMISSION_CUSTOMER_STRATEGIES=[ {"action": 3, "role": 2}, {"action": 6, "role": 2} ]
      
# 3. enable univer event sync
EVENT_SYNC=true  # 设置 true 为开启
      
# 4. use owner RDS
# postgresql config
DISABLE_UNIVER_RDS=true  # 使用自己的 RDS 时，需要设置禁止 Univer 部署默认的 postgresql
      
DATABASE_DRIVER=postgresql  #设置为 postgresql 代表使用兼容 postgresql 的数据库
DATABASE_HOST=univer-postgresql
DATABASE_PORT=5432
DATABASE_DBNAME=univer
DATABASE_USERNAME=universer-biz
DATABASE_PASSWORD=123456
      
# 5. use owner Object storage
# s3 config
DISABLE_UNIVER_S3=true  # 使用自己的 object storage 时，需要禁止 Univer 安装内建的 minio
      
S3_USER=universer-biz
S3_PASSWORD=123456
S3_REGION=cn-sz
S3_PATH_STYLE=true
S3_ENDPOINT=univer-s3:9652
S3_ENDPOINT_PUBLIC=univer.ai:9653
S3_DEFAULT_BUCKET=univer
      
# 6. change univer service Port
HOST_NGINX_PORT=8010
      
# 7. set the service scale
UNIVERSER_REPLICATION_CNT=4  # universer 实例数
COLLABORATION_SERVER_REPLICATION_CNT=5  # 协同服务实例数
MAX_MEMORY_LIMIT=2048  # 配置协同服务的最大内存限制，单位为 MB

collaboration-demo:
  enabled: false  # 设置为 false 则禁止部署 demo 服务
 
postgresql:
  enabled: false  # 禁止 Univer 部署自带的数据库
 
minio:
  enabled: false  # 禁止 Univer 部署自带的 minio
 
collaboration-server:
  replicaCount: 5
  maxMemoryLimit: 2048
 
universer:
  replicaCount: 4
  ingress:
    enabled: true
    hosts:
      - host: "usip-demo.univer.ai"  # 这里修改成你的域名
        paths:
          - path: /universer-api/
            pathType: Prefix
  config:
    usip:
      enabled: true  # 设置为 true 以启用 USIP
      uri:
        userinfo: "https://usip-demo.univer.ai/usip/userinfo"
        collaborators: "https://usip-demo.univer.ai/usip/collaborators"
        role: "https://usip-demo.univer.ai/usip/role"
        credential: "https://usip-demo.univer.ai/usip/credential"
    auth:
      permission:
        customerStrategies: '[ {"action": 3, "role": 2}, {"action": 6, "role": 2} ]'
    rabbitmq:
      eventSync: true  # 设置 true 为开启
    database:
      driver: postgresql
      host: univer-postgresql
      port: 5432
      dbname: univer
      username: universer-biz
      password: 123456
    s3:
      accessKeyID: universer-biz
      accessKeySecret: 123456
      region: "cn-sz"
      endpoint: "univer-s3:9652"
      endpointPublic: "univer.ai:9653"
      usePathStyle: true
      defaultBucket: univer
 
temporal:
  server:
    config:
      persistence:
        default:
          driver: "sql"
          sql:
            driver: "postgres12"
            host: univer-postgresql
            port: 5432
            database: temporal
            user: universer-temporal
            password: 123456
 
        visibility:
          driver: "sql"
          sql:
            driver: "postgres12"
            host: univer-postgresql
            port: 5432
            database: temporal_visibility
            user: universer-temporal
            password: 123456