設定アダプタ

Caddyのネイティブ構成言語はJSONですが、JSONを手書きするのは面倒で、エラーが発生しやすい場合があります。それ故、Caddyは設定アダプターを通じて、他の言語で構成されるサポートしています。それらは、Caddy JSONを出力することで、お好みのフォーマットで構成を使用できるようにする、Caddyプラグインです。

たとえば、設定アダプターはNGINX構成をCaddy JSONに変換できます。

既知の設定アダプター

以下の設定アダプターは現在利用できます（いくつかは、サードパーティープロジェクトです）

• caddyfile（標準）
• nginx
• jsonc
• json5
• yaml
• cue
• toml
• hcl
• dhall
• mysql

設定アダプターを使用する

構成を受け取るほとんどのサブコマンドで、--adapterフラグを使用してコマンドラインで指定することで、設定アダプターを使用できます。

caddy run --config caddy.yaml --adapter yaml

または、/ロードエンドポイントでAPI経由で

curl localhost:2019/load \
	-H "Content-Type: application/yaml" \
	--data-binary @caddy.yaml

実行せずに、出力JSONのみを取得したい場合は、caddy adaptコマンドを使用できます。

caddy adapt --config caddy.yaml --adapter yaml

注意事項

すべての設定言語がCaddyと100％互換性があるわけではありません。機能や動作によっては、うまく変換できなかったり、アダプターまたはCaddy自体でまだプログラミングされていなかったりするからです。

一部のアダプターは、YAML->JSONまたはTOML->JSONのように、1対1の翻訳を行います。CaddyfileのようにCaddy専用に設計されたものもあります。一般的に、これらのアダプターは常に機能します。

ただし、すべてのアダプターが常に機能するわけではありません。設定アダプターは、忠実度と正確性を最大限に高めて、入力をCaddy JSONに変換するために最善を尽くします。この変換プロセスが常に完了し正しくなることが保証されないため、それらを「コンバーター」または「トランスレータ」とは呼びません。それらが少なくとも最終的なJSON構成の作成を完了するための優れた出発点になるため、「アダプター」と呼ばれています。

構成アダプターが出力できるのは、処理後の JSON、警告、およびエラーです。エラーが発生しない場合は、JSON の結果が得られます。エラーは入力に問題がある場合（例: 構文エラー）に発生します。エラーではないものの、適応に問題がある場合は、警告が発行されます（例: サポートされていない機能）。警告付きで適応された構成を使用する場合は注意が必要です。