Docsbook
Обзор

Настройка собственного домена

Используйте собственный домен вместо docsbook.io для вашей документации.

Требуется: Премиум-подписка (единоразовый платеж 29 долларов США)

Почему использовать собственный домен?#

Преимущества#

  • 🎯 Брендирование — документация под вашим собственным доменом
  • 📈 SEO — ссылки на ваш домен улучшают ваш рейтинг
  • 🔐 Доверие — посетители видят ваш домен, а не чей-то другой
  • 💼 Профессионализм — выглядит как ваш собственный продукт

Примеры#

❌ Without domain:
docsbook.io/mycompany/product

✅ With domain:
docs.mycompany.com

Требования#

  1. Собственный домен — зарегистрированный вами

    • Если у вас его нет — купите на GoDaddy, Namecheap или другом регистраторе

  2. Премиум подписка — единоразовый платеж $29

  3. Доступ к настройкам DNS — у вашего регистратора домена

Шаг 1: Откройте Настройки#

  1. Просматривайте свою документацию, войдя в систему
  2. Нажмите на плавающее виджет в правом нижнем углу
  3. Откройте Настройки

Шаг 2: Введите Ваш Домен#

В разделе Custom Domain:

  1. Введите ваш домен (например, docs.example.com)
  2. Нажмите Save

Docsbook сгенерирует конфигурацию DNS.

Шаг 3: Обновление DNS#

Docsbook предоставит инструкции:

Add a CNAME record:
Type:  CNAME
Name:  docs (or @)
Value: cname.vercel-dns.com

Где изменить DNS?#

Откройте панель управления вашего регистратора доменов:

GoDaddy#

  1. Откройте godaddy.com → Войти
  2. Мои домены → Выбрать домен → DNS
  3. Нажмите "Добавить" рядом с DNS
  4. Заполните:
    • Тип: CNAME
    • Имя: docs
    • Указывает на: cname.vercel-dns.com
  5. Сохранить

Namecheap#

  1. Откройте namecheap.com → Войти
  2. Список доменов → Управление
  3. Расширенный DNS
  4. Добавить новую запись:
    • Тип: CNAME
    • Хост: docs
    • Значение: cname.vercel-dns.com
    • TTL: 3600
  5. Сохранить

Google Domains#

  1. Откройте domains.google.com
  2. Выберите домен
  3. DNS → Пользовательские записи
  4. Создать новую запись:
    • Тип записи DNS: CNAME
    • Имя: docs
    • Данные: cname.vercel-dns.com
  5. Сохранить

1and1 / Ionos#

  1. Войти → Домены
  2. Выберите домен
  3. Управление DNS
  4. Добавить запись:
    • Тип: CNAME
    • Поддомен: docs
    • Псевдоним: cname.vercel-dns.com
  5. Сохранить

Using a Root Domain#

If you want example.com (without docs):

  1. Our recommendation: use docs.example.com

    • Easier to configure
    • Lets you use example.com for the project site

  2. If you still want root:

    • Some registrars don't allow CNAME on root
    • Use an A record instead of CNAME: 76.76.19.0
    • Contact support@docsbook.io for help

Шаг 4: Ожидание#

После добавления записи DNS обновления распространяются:

  • Обычно: 15-30 минут
  • Максимум: 48 часов
  • Проверка статуса: используйте DNSChecker

Введите ваш домен → он должен показывать cname.vercel-dns.com

Шаг 5: SSL-сертификат#

После распространения DNS, Docsbook автоматически:

  1. Обнаруживает ваш домен
  2. Создает SSL-сертификат (Let's Encrypt)
  3. Включает HTTPS

Ваш сайт доступен по адресу:

https://docs.example.com ✅

Проверка вашего домена#

Как проверить, что все работает?#

Метод 1: Простая проверка

  1. Открыть в браузере: https://your-domain.com
  2. Ваша документация должна загрузиться

Метод 2: Проверка DNS

# In terminal
nslookup docs.example.com
# Should show: cname.vercel-dns.com

Метод 3: Онлайн-сервис

  1. Открыть mxtoolbox.com
  2. Поиск CNAME
  3. Введите свой домен
  4. Должно отображаться cname.vercel-dns.com

Устранение неполадок#

DNS Not Updating#

Problem: Прошло 2+ часа, но домен не работает

Solutions:

  1. Очистить кэш браузера (Ctrl+Shift+Delete)
  2. Использовать приватное окно браузера
  3. Проверить DNS через DNSChecker
  4. Убедиться, что запись CNAME добавлена правильно
  5. Подождать еще 24 часа

Старый сайт все еще отображается#

Проблема: DNS обновлен, но старая версия сайта

Решения:

  1. Нажмите Ctrl+F5 (полная очистка кэша)
  2. Открыть в приватном окне
  3. Подождите 24 часа

HTTPS Not Working#

Problem: https:// показывает ошибку сертификата

Solutions:

  1. Подождите 1 час — сертификат создается
  2. Убедитесь, что DNS обновился
  3. Проверьте имя домена на наличие опечаток
  4. Свяжитесь с support@docsbook.io

Домен показывает Vercel или ошибку#

Проблема: Посещение домена показывает сообщение Vercel

Решения:

  1. Проверьте, что домен добавлен в Docsbook (видно в Настройках)
  2. Убедитесь, что DNS CNAME верен
  3. Подождите 1-2 часа для синхронизации

Изменение вашего домена#

Как переключиться на другой?#

  1. Откройте настройки
  2. Измените домен в поле Custom Domain
  3. Нажмите Сохранить
  4. Обновите DNS для нового домена
  5. Старый домен перестанет работать

Удаление вашего домена#

Как вернуться на docsbook.io?#

  1. Откройте настройки
  2. Очистите поле Custom Domain
  3. Нажмите Сохранить

Документация вернется на:

docsbook.io/username/repo

Лучшие практики#

1. Использование поддомена#

✅ docs.example.com
✅ guide.example.com
✅ api.example.com

❌ example.com (if your main site is there)

2. Расскажите людям о домене#

Обновите ссылки на вашу документацию везде:

  • GitHub README
  • Сайт проекта
  • Подписи в электронной почте
  • Социальные сети

3. Настройка электронной почты (необязательно)#

Теперь, когда у вас есть домен, вы можете добавить электронную почту:

Это отдельный сервис от Docsbook, настраиваемый через вашего регистратора.

4. Use for SEO#

Теперь, когда сайт находится в вашем домене:

  • Настройте Google Analytics
  • Отслеживайте трафик
  • Отправьте в поисковые системы

Что дальше?#

Работает на Docsbook