Документерра: руководство пользователя

Пользовательское доменное имя для вашего портала

В системе Документерра можно изменить доменное имя по умолчанию на пользовательское имя по своему выбору. 

По умолчанию имя любого портала Документерры выглядит примерно так: mycompany.documenterra.co. Существует возможность присвоить порталу пользовательское доменное имя. Как правило, может возникнуть необходимость сделать портал документации поддоменом основного домена компании: docs.my-company-website.com. Это возможно, однако потребуется помощь ИТ-отдела, чтобы внести изменения в DNS-записи домена компании и получить соответствующий SSL-сертификат для доменного имени.

Примечание
Применение пользовательского доменного имени к порталу не означает потерю времени.   

Назначение пользовательского доменного имени

Для изменения доменного имени:

  • Перейдите на страницу Инструменты → Настройки портала
  • В левой навигационной панели нажмите АдминистрированиеУправление доменом. Откроется страница настроек Управление доменом, где можно настроить пользовательское доменное имя.
  • Выберите Применить пользовательское доменное имя, после чего появится раздел Отображение доменов:
Выберите опцию «Применить пользовательское доменное имя» в разделе «Отображение доменов» в настройках портала
  • Попросите ИТ-службу изменить DNS-записи через интерфейс регистратора домена. Смысл изменения прост — вы связываете имя портала по умолчанию со своим собственным доменным именем, создав специальную запись CNAME. Инструкции можно посмотреть на странице настроек в пункте №1 списка шагов.
    Важно
    Внесение DNS-записей может занять до 24 часов на стороне регистратора домена. Старые записи могут кэшироваться в сети, что увеличивает время обновления — можно перезагрузить интернет-прокси или маршрутизатор, чтобы обновить свои DNS-записи.
  • Введите новое доменное имя в соответствующем поле на шаге 2.
  • На шаге 3 загрузите SSL-сертификат и укажите пароль PFX-файла в соответствующем поле.
    Важно
    Для пользовательского имени требуется SSL-сертификат. В целях обеспечения безопасности в Интернете Документерра требует использовать защищенное соединение HTTPS для всех порталов документации. 
  • По завершении всех настроек нажмите кнопку Сохранить изменения, чтобы отправить нам запрос на изменение доменного имени. При этом автоматически будет создано обращение в службу поддержки. Мы проверим настройки, чтобы убедиться в правильности нового доменного имени, и применим изменения в течение 24 часов. Мы сообщим вам о внесении изменений в ответе службы поддержки на ваше обращение.

После обработки Вашего запроса Ваш Портал онлайн-документации станет доступен по новому пользовательскому доменному имени. Таким образом, вы получите уникальное доменное имя, которое будет соответствовать имени вашего основного сайта и повысит вашу узнаваемость в Интернете.

Получение SSL-сертификата

После смены доменного имени портала наш собственный SSL-сертификат перестанет работать, поскольку его действие распространяется только на поддомены *.documenterra.co. Для обеспечения безопасного канала связи необходимо загрузить собственный SSL-сертификат для пользовательского доменного имени. Вы можете приобрести сертификат в любом центре сертификации или использовать существующий сертификат wildcard для базового домена, если таковой имеется в вашем ИТ-отделе.

Возможный вариант получения бесплатного сертификата — запросить его на сайте цента сертификации Let's Encrypt.  Данный центр сертификации выдает бесплатные сертификаты безопасности, которые действительны в течение трех месяцев, поэтому не забывайте своевременно обновлять сертификат.