> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 構成の参照

> すべてのGOWA環境変数とコマンドラインフラグ、デフォルト。

GOWAは以下の3つの場所から設定を読み込みます。

* **コマンドラインフラグ** `whatsapp rest` (完全なリストは `./whatsapp rest --help` を実行してください)。
* **環境変数**
* 作業ディレクトリ **`.env` ファイル** (`src/.env` をソースから実行する場合は、 `src/.env.example` をコピーします)。

`.env`ファイルは、環境で設定されていない変数のみを入力します。

> [!WARNING]
>
> 現在のコードでは、 `.env`を含む環境変数が適用されます。 **after** フラグが解析されるので、 設定された変数はマッチするフラグを上書きします。 MCP OAuth設定、 `--allow-unauthenticated` 、 `--trusted-origins` 、 `--chatwoot-webhook-allow-unsigned` 、 `--webhook-all-device-receipts` は明示的なフラグが勝利した例外です。 各オプションを1つの場所のみに設定します。例えば `WHATSAPP_WEBHOOK_INSECURE_SKIP_VERIFY=true` は `--webhook-insecure-skip-verify=false` を上書きします。

Booleanは`true`/`false`を受け付けます。期間はGo構文（`30s`、`5m`、`3h`）を使用します。リストの値はカンマ区切りです。

## マーク

| (Command) | 説明 |
| - | - |
| `whatsapp rest` | REST API、ダッシュボード、WebSocket、MCP エンドポイントを開始します。v6 以降に必要なもの。裸の `whatsapp` はサーバーを起動しません。 |
| `whatsapp version` | バージョンを印刷して終了します。 |
| `whatsapp --help` | コマンドとフラグを一覧表示します。 |

## サーバー

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `APP_PORT` | `--port`, `-p` | `3000` | HTTP ポート。 |
| `APP_HOST` | `--host`, `-H` | `0.0.0.0` | バインドされたアドレス |
| `APP_DEBUG` | `--debug`, `-d` | `false` | 詳細なロギング。 |
| `APP_OS` | `--os` | `GOWA` | WhatsAppの**リンクされたデバイス**リストに表示されるデバイス名 |
| `APP_BASIC_AUTH` | `--basic-auth`, `-b` | — | `user:pass`ペア、カンマ区切りを完了します。明示的に認証されていないオーバーライドが設定されていない限り、ノンループバックリスナーに必要です。 |
| `APP_ALLOW_UNAUTHENTICATED` | `--allow-unauthenticated` | `false` | Basic 認証なしのノンループバックリスナーを許可します。直接アクセスが制限された認証プロキシの背後でのみ使用してください。 |
| `APP_TRUSTED_ORIGINS` | `--trusted-origins` | — | 状態を変更してWebSocketを開くことができるブラウザの起源を正確に調べてください。リクエストホストと特定のCORSの起源も信頼されています。 |
| `APP_BASE_PATH` | `--base-path` | — | `/gowa`のようなサブパスの下でサーブします。`/health`はルートに留まります。 |
| `APP_TRUSTED_PROXIES` | `--trusted-proxies` | — | 転送されたヘッダが信頼されるプロキシIP範囲。例: `10.0.0.0/8` 。 |
| `APP_CORS_ALLOWED_ORIGINS` | `--cors-allowed-origins` | — (任意の原点) | CORSのオリジン。特定のオリジンはブラウザのオリジンチェックも渡します。ワイルドカードは変更やWebSocketを許可しません。 |

## ダッシュボード

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `APP_UI_ENABLED` | `--ui-enabled` | `true` | gowa-ui ダッシュボードを `/` で提供します。 |
| `APP_UI_AUTO_UPDATE` | `--ui-auto-update` | `true` | 起動時および定期的に最新のダッシュボードリリースをダウンロードします。`storages/ui`キャッシュをあらかじめ設定しておくと、エアギャップのホストを無効にできます。 |
| `APP_UI_REPO` | `--ui-repo` | `aldinokemal/gowa-ui` | GitHub リポジトリからダウンロードします。 |
| `APP_UI_ASSET_NAME` | `--ui-asset-name` | `gowa-ui.html` | アセットをリリースしてダウンロードします。 |
| `APP_UI_UPDATE_INTERVAL` | `--ui-update-interval` | `3h` | 更新チェックの間隔。 |
| `APP_UI_GITHUB_TOKEN` | — | — | より高いAPIレート制限のためのGitHubトークン。 |
| `APP_UI_ASSET_SHA256` | `--ui-asset-sha256` | — | この SHA-256 のダッシュボードのみを表示します。 |

## MCP

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `MCP_ENABLED` | `--mcp-enabled` | `true` | `/mcp` で MCP エンドポイントを提供します。 |
| `MCP_OAUTH_ENABLED` | `--mcp-oauth-enabled` | `false` | `/mcp` では OAuth 2.1 を有効にします。`APP_BASIC_AUTH` が必要です。 |
| `MCP_OAUTH_ISSUER_URL` | `--mcp-oauth-issuer-url` | — | パブリックHTTPS発行者のURL。OAuthで必要です。 |
| `MCP_OAUTH_RESOURCE_URL` | `--mcp-oauth-resource-url` | issuer + Base path + `/mcp` | Canonical public MCP URL。 |
| `MCP_OAUTH_DB_URI` | `--mcp-oauth-db-uri` | `file:storages/oauth.db` | OAuthクライアントとトークンハッシュのSQLiteストア。 |

[MCP サーバ](https://gowa-docs.mintlify.site/ja/integrations/mcp.md)を参照してください。

## ストレージ

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `DB_URI` | `--db-uri` | `file:storages/whatsapp.db` | Session store: SQLite (`file:...`) or PostgreSQL (`postgres://...`). |
| `DB_KEYS_URI` | `--db-keys-uri` | `DB_URI`と同じ | 暗号化キーキャッシュ用のオプションの別ストアです。本番環境でのインメモリストアは避けてください。 |
| `CHAT_STORAGE_MAX_OPEN_CONNS` | — | `5` | チャットストレージ用の最大SQLite接続。大量のインバウンド負荷時にタイムアウトした場合は上昇。 |

チャットストレージ (チャット、メッセージ、スケジュール) は常に `storages/chatstorage.db` に保存されており、設定できません。

セッション、チャットストレージ、OAuth 用の SQLite データベースは、`0600` の権限で作成されます。これらのファイル用に GOWA が作成するディレクトリには `0700` が適用されます。既存のディレクトリの権限は維持されます。ファイルシステムが対応していない権限変更は、警告としてログに記録されます。

PostgreSQLセッションとキーストアの場合、省略または空白の`sslmode`はデフォルトで、リモートダイヤルターゲットの`verify-full`になります。 `localhost`、loopback IP、Unix ソケットのデフォルトは `disable` です。 明示的な URI 設定、 `PGSSLMODE` 、およびサービスの設定は引き続き有効です。`PGSERVICE` エントリは URI ホストと TLS モードを上書きできます。 管理対象PostgreSQLでは、明示的に`sslmode=verify-full`と必要なCA設定を提供します。

## WhatsAppの動作

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `WHATSAPP_AUTO_REPLY` | `--autoreply` | — | すべての受信メッセージに送信された返信を修正しました。 |
| `WHATSAPP_AUTO_MARK_READ` | `--auto-mark-read` | `false` | 受信メッセージを既読にする |
| `WHATSAPP_AUTO_DOWNLOAD_MEDIA` | `--auto-download-media` | `true` | 受信するメディアを `statics/media` に保存します。 |
| `WHATSAPP_IGNORE_STATUS_MEDIA` | `--ignore-status-media` | `false` | ステータスメディアのダウンロードをスキップ |
| `WHATSAPP_AUTO_REJECT_CALL` | `--auto-reject-call` | `false` | 着信拒否。 |
| `WHATSAPP_ACCOUNT_VALIDATION` | `--account-validation` | `true` | チェック受信者は、送信する前にのWhatsAppにあります。 |
| `WHATSAPP_PRESENCE_ON_CONNECT` | `--presence-on-connect` | `unavailable` | Presence sent on connect: `available`, `unavailable` or `none`. |
| `WHATSAPP_PRESENCE_PULSE_ENABLED` | `--presence-pulse-enabled` | `true` | 定期的にオンラインで簡単に、再びオフラインになります。 |
| `WHATSAPP_PRESENCE_PULSE_INTERVAL` | `--presence-pulse-interval` | `24h` | パルス間の時間。 |
| `WHATSAPP_PRESENCE_PULSE_DURATION` | `--presence-pulse-duration` | `5m` | 各パルスがオンラインのままの時間。 |
| `WHATSAPP_PROXY` | `--whatsapp-proxy` | — | WhatsApp接続のプロキシ: `socks5://`, `http://`, `https://`. `HTTP_PROXY` は適用されません。 |

## Webhooks

| 変数 | フラグ | デフォルト | 説明 |
| - | - | - | - |
| `WHATSAPP_WEBHOOK` | `--webhook`, `-w` | — | Webhook URLs, comma-separated. |
| `WHATSAPP_WEBHOOK_SECRET` | `--webhook-secret` | プロセスごとにランダムに表示 | `X-Hub-Signature-256`のHMACキー。安定して生成されたキーを設定します。空の場合、`secret`、`super-secret-key`、`your-private-key`は一時的なキーを生成します。 |
| `WHATSAPP_WEBHOOK_INSECURE_SKIP_VERIFY` | `--webhook-insecure-skip-verify` | `false` | TLS 検証をスキップします(開発のみ)。 |
| `WHATSAPP_WEBHOOK_EVENTS` | `--webhook-events` | — (すべて) | イベント許可リスト、例: `message,message.ack` |
| `WHATSAPP_WEBHOOK_IGNORE_JIDS` | `--webhook-ignore-jids` | — | JIDまたはワイルドカード（`@g.us`、`@s.whatsapp.net`、`@lid`）は転送されません。 |
| `WHATSAPP_WEBHOOK_DEVICE_MERGE_GLOBAL` | `--webhook-device-merge-global` | `false` | デバイスのイベントをグローバル URL や独自の Web フックに送信します。 |
| `WHATSAPP_WEBHOOK_ALL_DEVICE_RECEIPTS` | `--webhook-all-device-receipts` | `false` | 連絡先のリンクされたデバイスとそのプライマリデバイスからの領収書を転送します。1つのメッセージに対して複数の確認が生成される可能性があります。 |

[Webhooks](https://gowa-docs.mintlify.site/ja/concepts/webhooks.md) を参照してください。

## Chatwoot

| 変数 | フラグ | デフォルト |
| - | - | - |
| `CHATWOOT_ENABLED` | `--chatwoot-enabled` | `false` |
| `CHATWOOT_URL` | — | — |
| `CHATWOOT_API_TOKEN` | — | — |
| `CHATWOOT_ACCOUNT_ID` | — | — |
| `CHATWOOT_INBOX_ID` | — | — |
| `CHATWOOT_DEVICE_ID` | `--chatwoot-device-id` | — |
| `CHATWOOT_ALLOWED_HOSTS` | `--chatwoot-allowed-hosts` | — |
| `CHATWOOT_IMPORT_MESSAGES` | `--chatwoot-import-messages` | `false` |
| `CHATWOOT_DAYS_LIMIT_IMPORT_MESSAGES` | `--chatwoot-days-limit-import-messages` | `3` |
| `CHATWOOT_IMPORT_DB_URI` | `--chatwoot-import-db-uri` | — |
| `CHATWOOT_IMPORT_PLACEHOLDER_MEDIA_MESSAGE` | `--chatwoot-import-placeholder-media-message` | `true` |
| `CHATWOOT_IMPORT_MEDIA_WITH_REST` | `--chatwoot-import-media-with-rest` | `false` |
| `CHATWOOT_AUTO_CREATE` | `--chatwoot-auto-create` | `false` |
| `CHATWOOT_INBOX_NAME` | `--chatwoot-inbox-name` | `WhatsApp` |
| `CHATWOOT_WEBHOOK_URL` | `--chatwoot-webhook-url` | — |
| `CHATWOOT_WEBHOOK_SECRET` | `--chatwoot-webhook-secret` | — |
| `CHATWOOT_WEBHOOK_ALLOW_UNSIGNED` | `--chatwoot-webhook-allow-unsigned` | `false` |
| `CHATWOOT_WEBHOOK_SIGNATURE_TOLERANCE` | `--chatwoot-webhook-signature-tolerance` | `5m` |
| `CHATWOOT_REOPEN_CONVERSATION` | `--chatwoot-reopen-conversation` | `true` |
| `CHATWOOT_CONVERSATION_PENDING` | `--chatwoot-conversation-pending` | `false` |
| `CHATWOOT_IGNORE_JIDS` | `--chatwoot-ignore-jids` | — |
| `CHATWOOT_SIGN_MSG` | `--chatwoot-sign-msg` | `false` |
| `CHATWOOT_SIGN_DELIMITER` | `--chatwoot-sign-delimiter` | `\n\n` |
| `CHATWOOT_FORWARD_EDITS` | `--chatwoot-forward-edits` | `true` |
| `CHATWOOT_FORWARD_DELETES` | `--chatwoot-forward-deletes` | `true` |
| `CHATWOOT_EVENTS` | `--chatwoot-events` | 空の場合、`WHATSAPP_WEBHOOK_EVENTS` に従います |
| `CHATWOOT_MESSAGE_READ` | `--chatwoot-message-read` | `false` |
| `CHATWOOT_MESSAGE_DELETE` | `--chatwoot-message-delete` | `false` |
| `CHATWOOT_REVOKE_ON_DELETE` | `--chatwoot-revoke-on-delete` | `false` |

イベントフィルタと一方向の取り消しオプションは、v9.9.0以降のGOWA `main` で使用できます。動作と例については[Chatwoot integration](https://gowa-docs.mintlify.site/ja/integrations/chatwoot.md#%E8%A8%AD%E5%AE%9A)を参照してください。

## 固定制限

これらはコンパイルされており、設定で変更することはできません：

| 制限 | 値 |
| - | - |
| 画像アップロード | 20 MB |
| ドキュメントのアップロード | 50 MB |
| 動画のアップロードとHTTPリクエストの本文 | 100 MB |
| 着信メディアのダウンロード | 500 MB |
| リクエストのタイムアウト | 45 s (`504 GATEWAY_TIMEOUT`) |
| Webhook配信 | 試行ごとに10秒、試行回数5回です |

## メディア URL のダウンロード

メディア、ドキュメント、またはリンクのプレビューを取得するリクエストを送信する HTTP および HTTPS の URL を受け入れます。 公開 URL はループバック、プライベート、リンクローカル、メタデータ、マルチキャスト、予約先を取得します。 リダイレクトと実際にダイヤルされたアドレスがチェックされます。これらのダウンロードは直接接続され、`HTTP_PROXY` または `HTTPS_PROXY` は使用されません。

GOWA はディスクから `/statics` URL を読み込むことができます。 Chatwoot添付ファイルのダウンロードでは、構成済みのChatwoot宛先または許可済みホストを使用できます。 この例外は送信APIに送信された任意のURLには適用されません。ソースが非公開の場合はファイルアップロードを使用してください。

## 未使用

`src/.env.example` は `WHATSAPP_WEBHOOK_INCLUDE_OUTGOING` と `WHATSAPP_CHAT_STORAGE` を一覧表示していますが、現在のコードは読み取られません。

## 例

```bash .env theme={null}
APP_PORT=3000
APP_OS=MyCompany
APP_BASIC_AUTH=admin:a-long-random-password
APP_TRUSTED_PROXIES=10.0.0.0/8
DB_URI=postgres://gowa:replace-with-password@db.example.com:5432/gowa?sslmode=verify-full
WHATSAPP_WEBHOOK=https://example.com/wa-hook
WHATSAPP_WEBHOOK_SECRET=another-long-random-secret
WHATSAPP_WEBHOOK_EVENTS=message,message.ack
WHATSAPP_AUTO_MARK_READ=false
```

等価フラグ:

```bash theme={null}
./whatsapp rest --port=3000 --os=MyCompany \
  --basic-auth=admin:a-long-random-password \
  --webhook=https://example.com/wa-hook \
  --webhook-secret=another-long-random-secret \
  --webhook-events=message,message.ack
```


## Related topics

- [クイックスタート](https://gowa-docs.mintlify.site/ja/quickstart.md)
- [Webhooks](https://gowa-docs.mintlify.site/ja/concepts/webhooks.md)
- [グループの参加者リストを取得する](https://gowa-docs.mintlify.site/ja/api-reference/group/グループの参加者リストを取得する.md)
- [グループへの参加リクエストを拒否する](https://gowa-docs.mintlify.site/ja/api-reference/group/グループへの参加リクエストを拒否する.md)
- [参加者のグループへの参加リクエストを承認](https://gowa-docs.mintlify.site/ja/api-reference/group/参加者のグループへの参加リクエストを承認.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.