Перейти к основному содержимому

Навигация

clmBot — это легковесный клиент, развертываемый на вашем внутреннем сервере и предназначенный для автоматического развертывания и обновления SSL-сертификатов: он получает актуальные сертификаты из облака, записывает их в точки установки сертификатов на сервере и выполняет скрипты согласно конфигурации для перезагрузки служб промежуточного ПО.

Принцип работы​

Процесс обновления сертификатов clmBot выглядит следующим образом:

  1. До истечения срока действия сертификата облако автоматически перевыпускает сертификат и создает новый.
  2. clmBot получает актуальный сертификат через облачный push-канал или периодическое извлечение.
  3. clmBot пытается создать резервную копию и заменить локальные файлы сертификатов на сервере; ошибка резервного копирования регистрируется, но не препятствует дальнейшему обновлению.
  4. clmBot выполняет скрипт перезагрузки в соответствии с конфигурацией (after_script); вступит ли изменение в силу, зависит от результата выполнения скрипта и состояния промежуточного ПО.

Весь процесс не требует ручного входа на сервер для замены сертификата и не открывает внешним сторонам доступ к административному интерфейсу сервера.

Поддерживаемые способы обновления​

clmBot поддерживает два способа обновления сертификатов, которые можно выбирать независимо на разных серверах:

Способ обновленияРежим работыТребования к портамПодходящие сценарии
Облачный pushВ административной панели инициируется push, серверная часть clmBot на сервере принимает и обновляет сертификатТребуется открыть входящий порт 8862/tcpСетевая политика допускает открытие входящих портов, требуется немедленное вступление обновления в силу
Периодическое извлечениеЧерез crontab или планировщик Windows периодически запускается clmBot, проверяет и извлекает актуальный сертификатОткрывать входящий порт не требуется, нужен только исходящий доступ к облакуСерверы, на которых невозможно открыть входящий порт (рекомендуемый способ по умолчанию)

Подробные инструкции по настройке см. в разделе Способы обновления сертификатов.

Поддерживаемые платформы и промежуточное ПО​

Поддерживаемые операционные системы:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64; для старых версий Windows используется legacy-пакет совместимости)

Поддерживаемое промежуточное ПО и форматы сертификатов:

Промежуточное ПОФормат сертификатаОписание
nginxPEMРаздельное развертывание сертификата, цепочки CA и закрытого ключа
Apache HTTP ServerPEMРаздельное развертывание сертификата, цепочки CA и закрытого ключа
TomcatPEM / JKSПоддержка PEM-сертификата или JKS keystore
IISIISИмпорт PFX встроенным скриптом и обновление привязок сайтов, требуются права администратора
ExchangeExchangeПоддерживается только обновление; обнаружение, запросы и sync-server не поддерживаются, требуются права администратора
Другое (пользовательский скрипт)PFX и др.Поддержка любых сценариев через пользовательский after_script

Как выбрать документацию​

Сценарий использованияРекомендуемая страница
Первое использование, требуется быстрое развертывание и выполнение одного обновления сертификатаБыстрый старт
Изучение подробной настройки двух способов обновленияСпособы обновления сертификатов
Ручное добавление точки установки, синхронизация точки установки из административной панели, использование локальной веб-страницы конфигурацииУправление точками установки
Просмотр значений полей в config.yaml и переменных шаблона скриптаСправочник по конфигурации
Просмотр полных примеров установки и перезагрузки сертификатов для nginx, Apache, Tomcat и других промежуточных серверовПримеры конфигурации
Ограничение прав запуска clmBot в производственной среде, настройка sudoersТребования к правам запуска
Регистрация clmBot как системной службы, обновление версии, просмотр журналовРазвёртывание как службы и обновление

Быстрый старт​

Если вы впервые используете clmBot, рекомендуется действовать по следующему пути:

  1. Создайте AccessKey / AccessSecret в панели администратора.
  2. Скачайте clmBot и загрузите его на сервер.
  3. Выполните login для завершения подключения и активируйте узел в панели.
  4. Выполните discover-certificate для автоматического обнаружения сертификатов на сервере.
  5. Настройте способ обновления (push или периодическое получение по расписанию).

Полные шаги см. в разделе Быстрый старт.