Администрирование
Эта инструкция для администратора портала (portal_admin): вы уже установили Portal и работаете в браузере в разделе Админка.
Читайте сверху вниз или откройте нужную задачу из таблицы. На каждом шаге указано, куда нажать и что должно появиться на экране.
Установка сервера и выбор канала развёртывания — в разделе Установка.
0. Что вы сможете сделать
Заголовок раздела «0. Что вы сможете сделать»После знакомства с этими страницами вы сможете:
- Включать и настраивать фоновые службы (почта, AD, поиск, бэкап, корзина и др.).
- Создавать группы доступа и выдавать права отделам.
- Делать резервные копии и восстанавливать портал.
- Найти, куда в админке лежат LDAP, SMTP, Keycloak, лицензия и обновления.
1. Как открыть админку
Заголовок раздела «1. Как открыть админку»- Войдите в Portal под учётной записью с правами администратора.
- В шапке или боковом меню откройте Админка.
- Должны увидеть вкладки вроде Обзор, Службы, Пользователи, Группы, Задания, Настройки.
Если пункта Админка нет — у вашей учётки нет роли администратора. Попросите другого администратора отметить флаг Администратор в Админка → Пользователи.
2. Разделы документации
Заголовок раздела «2. Разделы документации»| Тема | Страница | Простыми словами |
|---|---|---|
| Каталог служб | Службы | Что делает каждая фоновая служба и как её включить |
| Резервное копирование | Бэкап | Как сохранить и вернуть данные портала |
| Группы Portal и AD | Группы доступа | Как собрать отделы и роли для прав |
| Обновление | Обновление Portal | Как обновить версию из админки или CLI |
| LDAP, SMTP и внешние сервисы | Внешние сервисы | Подключение каталога и почты на уровне сервера |
| REST API админки | API: администрирование | Автоматизация для интеграций |
3. Карта экранов админки
Заголовок раздела «3. Карта экранов админки»| Куда нужно попасть | Куда нажать / какой адрес |
|---|---|
| Список служб | Вкладка Службы. Действия — меню ⋮ у строки. Справка — ? у названия |
| LDAP и синхронизация AD | Службы → Синхронизация AD → ⚙ Настройки (/services/ad-sync) |
| Бэкап и восстановление | Службы → Резервное копирование → ⚙ Настройки (/services/portal-backup) |
| Почта (SMTP) | Настройки → SMTP / Почта (отдельной страницы службы нет) |
| Вход через Keycloak | Настройки → Keycloak SSO (включение службы keycloak-sso) |
| Лицензия и обновление | Настройки → Продукт и лицензия |
| Карточка пользователя | Пользователи → клик по пользователю (/users/{id}) |
| Группы | Вкладка Группы: список /groups, создание /groups/new, карточка /groups/{uuid} |
| Журнал заданий | Вкладка Задания |
| Состояние обслуживания | Обзор → Обслуживание (индекс, корзина, runner бэкапа) |
4. Типичные задачи — по шагам
Заголовок раздела «4. Типичные задачи — по шагам»4.1. Подключить Active Directory / LDAP
Заголовок раздела «4.1. Подключить Active Directory / LDAP»- Откройте Службы → Синхронизация AD → ⚙ Настройки.
- Заполните блок Подключение (URL, Base DN, учётная запись для чтения каталога).
- В блоке Настройка синхронизации отметьте нужные поля профиля и, при необходимости, Синхронизировать группы AD.
- Вернитесь на вкладку Службы → у строки Синхронизация AD меню ⋮ → Включить.
- При необходимости: ⋮ → Расписание или ⋮ → Запустить.
Подробнее: ad-sync в каталоге служб, Группы доступа.
4.2. Включить исходящую почту
Заголовок раздела «4.2. Включить исходящую почту»- Настройки → SMTP / Почта — укажите сервер, порт, From, при необходимости логин и пароль.
- Нажмите тест SMTP (если есть) — письмо-проверка сервера.
- Службы → Уведомления → ⋮ → Включить.
- Для проверки: ⋮ → Запустить и введите свой e-mail — должно прийти тестовое письмо.
Подробнее: notifications.
4.3. Включить вход через Keycloak
Заголовок раздела «4.3. Включить вход через Keycloak»- Откройте Настройки → Keycloak SSO.
- Укажите
Issuer URL,Client ID,Client Secretи claims (по умолчанию подходят для стандартного Keycloak). - Включите чекбокс Включить вход через Keycloak и сохраните форму.
- На экране входа появится третий переключатель Keycloak.
Для client в Keycloak используйте redirect URI:
https://<portal-host>/api/v1/auth/keycloak/callback.
4.4. Настроить резервное копирование
Заголовок раздела «4.4. Настроить резервное копирование»- Убедитесь, что на сервере работает backup-runner (в Docker он обычно поднимается вместе со стеком).
- Откройте
/services/portal-backup. - Укажите путь, нажмите Проверить запись, дождитесь Runner online.
- Нажмите Создать резервную копию или задайте расписание через ⋮ → Расписание.
Подробнее: Бэкап.
4.5. Ночной поиск, корзина, журнал заданий
Заголовок раздела «4.5. Ночной поиск, корзина, журнал заданий»Эти службы обычно уже включены с ночным расписанием. Проверить и запустить вручную:
- Откройте Админка → Службы.
- Найдите строку (Поисковый индекс, Корзина, Журнал заданий).
- Меню ⋮ — Включить, Расписание или Запустить.
Состояние индекса и корзины смотрите в Обзор → Обслуживание. Подробнее: Службы.
5. Куда идти дальше
Заголовок раздела «5. Куда идти дальше»| Цель | Документ |
|---|---|
| Понять все встроенные службы | Службы |
| Бэкап и restore | Резервное копирование |
| Группы для прав | Группы доступа |
| Инструкции для сотрудников | Руководство пользователя |
| Задачи (таймлайн и канбан) | Задачи |
| Helpdesk | Helpdesk |