Внутренняя документация

Внутренняя документация

Этот раздел содержит внутреннюю документацию компании и доступен только сотрудникам поддержки и администраторам.

Техническая документация

Архитектура системы Wiki Iridium

Компоненты системы:

  • Frontend: Hugo Static Site Generator (порт 1313)
  • Backend: Go API (Gin Framework, порт 8000)
  • База данных: PostgreSQL
  • Авторизация: JWT токены
  • Развертывание: systemd сервисы

Служебные команды

Управление сервисами:

# Перезапуск Hugo
systemctl restart iridium-hugo.service

# Перезапуск API
systemctl restart iridium-api.service

# Проверка статуса
systemctl status iridium-hugo.service
systemctl status iridium-api.service

Обновление IP адреса:

cd /opt
./update-ip.sh

Управление пользователями

Создание пользователей

Роли в системе:

  • client - базовый доступ (документация, FAQ)
  • support - расширенный доступ (+ внутренняя документация)
  • admin - полный доступ (+ администрирование)

Процедура добавления пользователя:

  1. Зайти в админ панель: /admin/
  2. Нажать “Добавить пользователя”
  3. Заполнить данные: username, email, пароль, роль
  4. Сохранить

Сброс паролей

Автоматический сброс:

  • Пользователь использует “Забыли пароль?” на странице входа
  • Система отправляет email с токеном восстановления

Ручной сброс (для админов):

  1. Зайти в админ панель
  2. Найти пользователя
  3. Нажать “Изменить пароль”
  4. Установить новый пароль

Процедуры поддержки

Решение типовых проблем

Проблема: Пользователь не может войти

  1. Проверить правильность логина/пароля
  2. Убедиться что аккаунт не заблокирован
  3. Проверить статус сервисов
  4. При необходимости сбросить пароль

Проблема: Доступ запрещен к разделу

  1. Проверить роль пользователя в админ панели
  2. Убедиться что роль соответствует требуемой для раздела
  3. При необходимости изменить роль

Проблема: Страница не загружается

  1. Проверить статус сервисов Hugo и API
  2. Проверить доступность базы данных
  3. Проверить логи сервисов
  4. При необходимости перезапустить сервисы

Мониторинг системы

Ключевые метрики:

  • Статус сервисов: systemctl status iridium-*
  • Логи Hugo: journalctl -u iridium-hugo.service -f
  • Логи API: journalctl -u iridium-api.service -f
  • Использование ресурсов: htop

Регулярные проверки:

  • Ежедневно: статус сервисов
  • Еженедельно: логи на ошибки
  • Ежемесячно: очистка старых логов

Регламенты работы

Обновление документации

Процедура обновления контента:

  1. Создать/отредактировать .md файлы в content/
  2. Проверить корректность разметки Markdown
  3. При изменении структуры обновить навигацию
  4. Перезапустить Hugo: systemctl restart iridium-hugo.service

Структура контента:

content/
├── _index.md           # Главная страница
├── docs/              # Основная документация
├── faq/               # Часто задаваемые вопросы
├── internal/          # Внутренняя документация (support, admin)
├── admin/             # Администрирование (admin only)
└── profile.md         # Профиль пользователя

Резервное копирование

Что необходимо сохранять:

  • База данных PostgreSQL
  • Файлы конфигурации (.env)
  • Контент сайта (папка content/)
  • Пользовательские шаблоны и стили

Периодичность:

  • База данных: ежедневно
  • Файлы: еженедельно

🔒 Политики безопасности

Управление доступом

Принципы:

  • Минимальные необходимые права
  • Регулярный аудит пользователей
  • Обязательная смена паролей раз в 90 дней
  • Блокировка неактивных аккаунтов

Требования к паролям

Минимальные требования:

  • Длина: не менее 8 символов
  • Содержать цифры и буквы
  • Не должен совпадать с логином
  • Не должен быть в списке популярных паролей

Логирование и аудит

Логируемые события:

  • Успешные и неуспешные попытки входа
  • Изменения ролей пользователей
  • Создание/удаление аккаунтов
  • Доступ к конфиденциальным разделам

📞 Эскалация инцидентов

Уровни критичности

Критический (P1):

  • Полная недоступность системы
  • Компрометация безопасности
  • Потеря данных

Высокий (P2):

  • Частичная недоступность
  • Ошибки авторизации
  • Некорректная работа ключевых функций

Средний (P3):

  • Проблемы с отдельными разделами
  • Медленная работа
  • Косметические дефекты

Низкий (P4):

  • Пожелания по улучшению
  • Незначительные баги

Контакты для эскалации

Системный администратор:

  • Роль: admin
  • Ответственность: техническое обслуживание, доступы

Ответственный за контент:

  • Роль: support/admin
  • Ответственность: наполнение и обновление документации

Отчетность

Еженедельные отчеты

Включают:

  • Статистика посещений
  • Количество новых пользователей
  • Инциденты и их решение
  • Обновления системы

Ежемесячные отчеты

Включают:

  • Аналитика использования разделов
  • Производительность системы
  • Планы развития
  • Бюджет на обслуживание

Важно: Данная документация содержит служебную информацию.
Не передавайте содержимое третьим лицам без соответствующих полномочий.

Последнее обновление: Декабрь 2024
Версия документа: 1.2