Конфигураторы адаптеров

Родной язык конфигурации Caddy — JSON, но ручная запись JSON может быть утомительной и подвержена ошибкам. Именно поэтому Caddy поддерживает конфигурирование с использованием других языков через конфигураторы адаптеров. Это плагины Caddy, которые позволяют использовать конфигурацию в вашем предпочитаемом формате, выгружая Caddy JSON для вас.

Например, конфигуратор адаптера может преобразовать вашу конфигурацию NGINX в Caddy JSON.

Известные конфигураторы адаптеров

Следующие конфигураторы адаптеров в настоящее время доступны (некоторые являются сторонними проектами):

• caddyfile (стандартный)
• nginx
• jsonc
• json5
• yaml
• cue
• toml
• hcl
• dhall
• mysql

Использование конфигураторов адаптеров

Вы можете использовать конфигуратор адаптера, указав его в командной строке, используя флаг --adapter на большинстве подкоманд, принимающих конфигурацию:

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

Или через API на /load конечной точке:

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

Если вы хотите получить только выходной JSON без его запуска, вы можете использовать команду caddy adapt:

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

Ограничения

Не все языки конфигурации на 100% совместимы с Caddy; некоторые функции или поведение просто не переводятся хорошо или ещё не запрограммированы в адаптер или сам Caddy.

Некоторые адаптеры выполняют 1:1 перевод, например, YAML->JSON или TOML->JSON. Другие разработаны специально для Caddy, например, Caddyfile. Как правило, эти адаптеры всегда работают.

Однако не все адаптеры работают всегда. Конфигураторы адаптеров делают всё возможное, чтобы преобразовать ваш ввод в Caddy JSON с наибольшей точностью и корректностью. Поскольку этот процесс преобразования не гарантирует полноты и правильности всегда, мы не называем их «конвертерами» или «переводчиками». Они являются «адаптерами», так как, по крайней мере, дадут вам хорошую отправную точку для завершения создания вашей окончательной конфигурации JSON.

Конфигураторы адаптеров могут выводить результирующий JSON, предупреждения и ошибки. Результат JSON, если ошибок нет. Ошибки возникают, когда в вводе есть ошибки (например, синтаксические ошибки). Предупреждения выдаются, когда адаптация содержит ошибки, но которые не обязательно являются фатальными (например, функция не поддерживается). Следует соблюдать осторожность при использовании конфигураций, которые были адаптированы с предупреждениями.