docker-compose 快速部署 Soketi

2023-03-24 08:55:53 浏览数 (1)

docker-compose

代码语言:javascript复制
version: '3'
# 使用外部网络
# docker network create server_web-network
networks:
  server_web-network:
    external: true

services:
  docker-soketi:
    image: 'quay.io/soketi/soketi:1.5.0-16-debian'
#    environment:
#      SOKETI_DEBUG: '1'
#      SOKETI_METRICS_SERVER_PORT: '9601'
#      SOKETI_DEFAULT_APP_ID: '12345'
#      SOKETI_DEFAULT_APP_KEY: 'ABCDEFG'
#      SOKETI_DEFAULT_APP_SECRET: 'HIJKLMNOP'
    command: ["node", "/app/bin/server.js", "start", "--config=/app/config.json"]
    volumes:
#      - ./data/app:/app
#      - ./data/app:/backup
#      - ./data/.env:/app/.env
      - ./data/config.json:/app/config.json
    ports:
      - '6001:6001'
      - '9601:9601'
    networks:
      - server_web-network

环境变量

支持的环境变量

代码语言:javascript复制
# cat app/dist/cli/cli.js

        this.envVariables = {
            ADAPTER_DRIVER: 'adapter.driver',
            ADAPTER_CLUSTER_REQUESTS_TIMEOUT: 'adapter.cluster.requestsTimeout',
            ADAPTER_REDIS_PREFIX: 'adapter.redis.prefix',
            ADAPTER_REDIS_CLUSTER_MODE: 'adapter.redis.clusterMode',
            ADAPTER_REDIS_REQUESTS_TIMEOUT: 'adapter.redis.requestsTimeout',
            ADAPTER_REDIS_SUB_OPTIONS: 'adapter.redis.redisSubOptions',
            ADAPTER_REDIS_PUB_OPTIONS: 'adapter.redis.redisPubOptions',
            ADAPTER_NATS_PREFIX: 'adapter.nats.prefix',
            ADAPTER_NATS_SERVERS: 'adapter.nats.servers',
            ADAPTER_NATS_USER: 'adapter.nats.user',
            ADAPTER_NATS_PASSWORD: 'adapter.nats.pass',
            ADAPTER_NATS_TOKEN: 'adapter.nats.token',
            ADAPTER_NATS_TIMEOUT: 'adapter.nats.timeout',
            ADAPTER_NATS_REQUESTS_TIMEOUT: 'adapter.nats.requestsTimeout',
            ADAPTER_NATS_NODES_NUMBER: 'adapter.nats.nodesNumber',
            APP_MANAGER_DRIVER: 'appManager.driver',
            APP_MANAGER_CACHE_ENABLED: 'appManager.cache.enabled',
            APP_MANAGER_CACHE_TTL: 'appManager.cache.ttl',
            APP_MANAGER_DYNAMODB_TABLE: 'appManager.dynamodb.table',
            APP_MANAGER_DYNAMODB_REGION: 'appManager.dynamodb.region',
            APP_MANAGER_DYNAMODB_ENDPOINT: 'appManager.dynamodb.endpoint',
            APP_MANAGER_MYSQL_TABLE: 'appManager.mysql.table',
            APP_MANAGER_MYSQL_VERSION: 'appManager.mysql.version',
            APP_MANAGER_POSTGRES_TABLE: 'appManager.postgres.table',
            APP_MANAGER_POSTGRES_VERSION: 'appManager.postgres.version',
            APP_MANAGER_MYSQL_USE_V2: 'appManager.mysql.useMysql2',
            CHANNEL_LIMITS_MAX_NAME_LENGTH: 'channelLimits.maxNameLength',
            CHANNEL_CACHE_TTL: 'channelLimits.cacheTtl',
            CACHE_DRIVER: 'cache.driver',
            CACHE_REDIS_CLUSTER_MODE: 'cache.redis.clusterMode',
            CACHE_REDIS_OPTIONS: 'cache.redis.redisOptions',
            CLUSTER_CHECK_INTERVAL: 'cluster.checkInterval',
            CLUSTER_HOST: 'cluster.hostname',
            CLUSTER_IGNORE_PROCESS: 'cluster.ignoreProcess',
            CLUSTER_BROADCAST_ADDRESS: 'cluster.broadcast',
            CLUSTER_KEEPALIVE_INTERVAL: 'cluster.helloInterval',
            CLUSTER_MASTER_TIMEOUT: 'cluster.masterTimeout',
            CLUSTER_MULTICAST_ADDRESS: 'cluster.multicast',
            CLUSTER_NODE_TIMEOUT: 'cluster.nodeTimeout',
            CLUSTER_PORT: 'cluster.port',
            CLUSTER_PREFIX: 'cluster.prefix',
            CLUSTER_UNICAST_ADDRESSES: 'cluster.unicast',
            DEBUG: 'debug',
            DEFAULT_APP_ID: 'appManager.array.apps.0.id',
            DEFAULT_APP_KEY: 'appManager.array.apps.0.key',
            DEFAULT_APP_SECRET: 'appManager.array.apps.0.secret',
            DEFAULT_APP_MAX_CONNS: 'appManager.array.apps.0.maxConnections',
            DEFAULT_APP_ENABLE_CLIENT_MESSAGES: 'appManager.array.apps.0.enableClientMessages',
            DEFAULT_APP_ENABLED: 'appManager.array.apps.0.enabled',
            DEFAULT_APP_MAX_BACKEND_EVENTS_PER_SEC: 'appManager.array.apps.0.maxBackendEventsPerSecond',
            DEFAULT_APP_MAX_CLIENT_EVENTS_PER_SEC: 'appManager.array.apps.0.maxClientEventsPerSecond',
            DEFAULT_APP_MAX_READ_REQ_PER_SEC: 'appManager.array.apps.0.maxReadRequestsPerSecond',
            DEFAULT_APP_USER_AUTHENTICATION: 'appManager.array.apps.0.enableUserAuthentication',
            DEFAULT_APP_WEBHOOKS: 'appManager.array.apps.0.webhooks',
            DB_POOLING_ENABLED: 'databasePooling.enabled',
            DB_POOLING_MIN: 'databasePooling.min',
            DB_POOLING_MAX: 'databasePooling.max',
            DB_MYSQL_HOST: 'database.mysql.host',
            DB_MYSQL_PORT: 'database.mysql.port',
            DB_MYSQL_USERNAME: 'database.mysql.user',
            DB_MYSQL_PASSWORD: 'database.mysql.password',
            DB_MYSQL_DATABASE: 'database.mysql.database',
            DB_POSTGRES_HOST: 'database.postgres.host',
            DB_POSTGRES_PORT: 'database.postgres.port',
            DB_POSTGRES_USERNAME: 'database.postgres.user',
            DB_POSTGRES_PASSWORD: 'database.postgres.password',
            DB_POSTGRES_DATABASE: 'database.postgres.database',
            DB_REDIS_HOST: 'database.redis.host',
            DB_REDIS_PORT: 'database.redis.port',
            DB_REDIS_DB: 'database.redis.db',
            DB_REDIS_USERNAME: 'database.redis.username',
            DB_REDIS_PASSWORD: 'database.redis.password',
            DB_REDIS_KEY_PREFIX: 'database.redis.keyPrefix',
            DB_REDIS_SENTINELS: 'database.redis.sentinels',
            DB_REDIS_SENTINEL_PASSWORD: 'database.redis.sentinelPassword',
            DB_REDIS_CLUSTER_NODES: 'database.redis.clusterNodes',
            DB_REDIS_INSTANCE_NAME: 'database.redis.name',
            EVENT_MAX_BATCH_SIZE: 'eventLimits.maxBatchSize',
            EVENT_MAX_CHANNELS_AT_ONCE: 'eventLimits.maxChannelsAtOnce',
            EVENT_MAX_NAME_LENGTH: 'eventLimits.maxNameLength',
            EVENT_MAX_SIZE_IN_KB: 'eventLimits.maxPayloadInKb',
            HOST: 'host',
            HTTP_ACCEPT_TRAFFIC_MEMORY_THRESHOLD: 'httpApi.acceptTraffic.memoryThreshold',
            METRICS_ENABLED: 'metrics.enabled',
            METRICS_DRIVER: 'metrics.driver',
            METRICS_HOST: 'metrics.host',
            METRICS_PROMETHEUS_PREFIX: 'metrics.prometheus.prefix',
            METRICS_SERVER_PORT: 'metrics.port',
            MODE: 'mode',
            PORT: 'port',
            PATH_PREFIX: 'pathPrefix',
            PRESENCE_MAX_MEMBER_SIZE: 'presence.maxMemberSizeInKb',
            PRESENCE_MAX_MEMBERS: 'presence.maxMembersPerChannel',
            QUEUE_DRIVER: 'queue.driver',
            QUEUE_REDIS_CONCURRENCY: 'queue.redis.concurrency',
            QUEUE_REDIS_OPTIONS: 'queue.redis.redisOptions',
            QUEUE_REDIS_CLUSTER_MODE: 'queue.redis.clusterMode',
            QUEUE_SQS_REGION: 'queue.sqs.region',
            QUEUE_SQS_CLIENT_OPTIONS: 'queue.sqs.clientOptions',
            QUEUE_SQS_URL: 'queue.sqs.queueUrl',
            QUEUE_SQS_ENDPOINT: 'queue.sqs.endpoint',
            QUEUE_SQS_PROCESS_BATCH: 'queue.sqs.processBatch',
            QUEUE_SQS_BATCH_SIZE: 'queue.sqs.batchSize',
            QUEUE_SQS_POLLING_WAIT_TIME_MS: 'queue.sqs.pollingWaitTimeMs',
            RATE_LIMITER_DRIVER: 'rateLimiter.driver',
            RATE_LIMITER_REDIS_OPTIONS: 'rateLimiter.redis.redisOptions',
            RATE_LIMITER_REDIS_CLUSTER_MODE: 'rateLimiter.redis.clusterMode',
            SHUTDOWN_GRACE_PERIOD: 'shutdownGracePeriod',
            SSL_CERT: 'ssl.certPath',
            SSL_KEY: 'ssl.keyPath',
            SSL_PASS: 'ssl.passphrase',
            SSL_CA: 'ssl.caPath',
            USER_AUTHENTICATION_TIMEOUT: 'userAuthenticationTimeout',
            WEBHOOKS_BATCHING: 'webhooks.batching.enabled',
            WEBHOOKS_BATCHING_DURATION: 'webhooks.batching.duration',
        };

docker-compose设置环境变量

方式1

支持的变量见上文,上文变量加SOKETI_前缀即可

代码语言:javascript复制
#    environment:
#      SOKETI_DEBUG: '1'
#      SOKETI_METRICS_SERVER_PORT: '9601'
#      SOKETI_DEFAULT_APP_ID: '12345'
#      SOKETI_DEFAULT_APP_KEY: 'ABCDEFG'
#      SOKETI_DEFAULT_APP_SECRET: 'HIJKLMNOP'

方式2

/app目录下增加.env文件

代码语言:javascript复制
    volumes:
      - ./data/.env:/app/.env

.env文件大致如下

代码语言:javascript复制
SOKETI_DEBUG=1
SOKETI_METRICS_SERVER_PORT=9601
SOKETI_DEFAULT_APP_ID=12345
SOKETI_DEFAULT_APP_KEY=ABCDEFG
SOKETI_DEFAULT_APP_SECRET=HIJKLMNOP

支持的变量见上文,上文变量加SOKETI_前缀即可

方式3

启动时支持config参数,可以指定一个json文件

代码语言:javascript复制
    command: ["node", "/app/bin/server.js", "start", "--config=/app/config.json"]

json文件大致如下

代码语言:javascript复制
{
  "debug": true,
  "port": 6001,
  "appManager.array.apps": [
    {
      "id": "12345",
      "key": "ABCDEFG",
      "secret": "HIJKLMNOP",
      "webhooks": [
        {
          "url": "https://...",
          "event_types": ["channel_occupied"]
        }
      ]
    }
  ]
}

这3种方式,选1种即可,推荐方式3

参考

https://docs.soketi.app/v/soketi-docs/getting-started/environment-variables

https://github.com/soketi/soketi

0 人点赞