> For AI agents: the complete documentation index is available at /resource/ucidm/docs/on-premise/dev/llms.txt, the full documentation bundle is available at /resource/ucidm/docs/on-premise/dev/llms-full.txt.

# 外部連携モジュール \{#consumer-service}

UCIDM は複数の外部連携先への ID 連携に対応しています。

外部連携モジュールはコンテナとして稼働させます。次のように `compose.yml` に設定します。entrypoint では次の設定ができます。

- `-verbose`: デバッグログを出力
- `-jsonl`: JSON 形式でログを出力

```yml
  consumer:
    depends_on:
      mongo:
        condition: service_healthy
      rabbitmq:
        condition: service_healthy
    container_name: consumer
    image: docker.io/osstech/ucidm-consumer:latest
    logging: *default-logging
    volumes:
      - type: bind
        source: ./server-data
        target: /ucidm
        bind:
          create_host_path: false
    entrypoint:
      - ./bin/consumer
      - -jsonl
    environment:
      TZ: "${TZ}"
      MONGO_USER: "${MONGO_USER}"
      MONGO_PASSWORD: "${MONGO_PASSWORD}"
      MONGO_HOSTS: "${MONGO_HOSTS}"
      MONGO_REPLICA_SET: "${MONGO_REPLICA_SET}"
      RABBITMQ_USER: "${RABBITMQ_USER}"
      RABBITMQ_PASSWORD: "${RABBITMQ_PASSWORD}"
      RABBITMQ_HOST: "${RABBITMQ_HOST}"
    ports:
      - 7099:7099
    restart: "always"
```

ここで参照する環境変数は `ucidm.env` に設定します。

## 環境変数の設定 \{#environment-variables}

| 環境変数                   |        値       |  既定値  | 説明                                                    |
| :--------------------- | :------------: | :---: | :---------------------------------------------------- |
| TZ                     |       任意       |   --  | タイムゾーン情報                                              |
| MONGO_USER             |       任意       |   --  | 接続する MongoDB のユーザ名                                    |
| MONGO_PASSWORD         |       任意       |   --  | 接続する MongoDB のパスワード                                   |
| MONGO_DATABASE         |       任意       | ucidm | 接続する MongoDB のデータベース                                  |
| MONGO_HOSTS            |       任意       |   --  | 接続する MongoDB のホスト                                     |
| MONGO_REPLICA_SET      |       任意       |   --  | 接続する MongoDB のレプリカセットの名前                              |
| RABBITMQ_USER          |       任意       |   --  | 接続する RabbitMQ のユーザ名                                   |
| RABBITMQ_PASSWORD      |       任意       |   --  | 接続する RabbitMQ のパスワード                                  |
| RABBITMQ_HOST          |       任意       |   --  | 接続する RabbitMQ のホスト                                    |
| ENABLE_SCRIPT_PASSWORD | true または false | false | ユーザーパスワード更新時に外部連携の<br />前処理/後処理スクリプトにパスワードの値を連携するかどうか |