commit 619b9ca0dbe95f2e112e27d799da5d073cf49555 Author: devops Date: Tue Nov 18 17:43:42 2025 +0200 Added SSO doc diff --git a/README.md b/README.md new file mode 100644 index 0000000..00b9155 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# 📘 Документация проекта + +Этот репозиторий содержит технические руководства и инструкции, оформленные в виде Markdown-документов. +Здесь собраны практические мануалы по различным компонентам инфраструктуры, настройкам, процессам деплоя и внутренним инструментам. + +Структура репозитория организована так, чтобы каждый мануал был изолирован и включал собственные изображения, примеры и сопутствующие материалы. + +--- + +## 🗂 Структура репозитория +```bash +manuals/ +/ + README.md — основной файл мануала + images/ — изображения, схемы, скриншоты +``` +Каждый мануал расположен в отдельном каталоге внутри `docs/` и включает: + +- подробные инструкции по теме +- примеры конфигураций +- схемы и иллюстрации +- последовательные шаги настройки или развёртывания + +## 📑 Список доступных мануалов + +- **SSO** — Регистрация в корпоративной SSO + +## 🎯 Цели репозитория + +- Централизованное хранение технической документации +- Унифицированный формат написания мануалов +- Удобная, масштабируемая структура +- Быстрый доступ к инструкциям в Git-репозитории +- Прозрачная история изменений каждого документа + +--- + +## 🛠 Требования к оформлению мануалов + +- **Один мануал = один каталог** +- **Изображения хранятся только в подкаталоге `images/`** +- Ссылки на изображения задаются относительными путями: + ```markdown + ![пример](./images/screenshot.png) \ No newline at end of file diff --git a/docs/SSO/Register_in_SSO.md b/docs/SSO/Register_in_SSO.md new file mode 100644 index 0000000..9ee9f2d --- /dev/null +++ b/docs/SSO/Register_in_SSO.md @@ -0,0 +1,46 @@ +### Введение +Для обеспечения лучшей безопасности и избежания траблов с организацией доступов до конечных сервисов у нас реализована SSO система с обязательным 2FA. Система располагается на внутренней инфре и в дальнейшем будет перенесена в закрытый контур. + +### Инструкция +Под всех разработчиков заранее были созданы учетки в Authentik, ваши креды необходимо запросить у Tech Lead (GD). +После получения кредов аутентифицируемся в Authentik, после чего нас попросят обновить ваш пароль и добавить почту ( введите свою рабочую почту т.к она дальше засинкается во все внутренние сервисы ). Совет ставить сложный пароль, минимум из 20 символов, можно и нужно использовать спец символы. + +![authentik_first_login](images/SSO/authentik_first_login.png) + +После смены пароля на более надежный нас попросят добавить 2FA. +В качестве MFA можно использовать любой клиент, в случае недоверия к корпоратам берем FreeOTP. + +![authentik_mfa](images/SSO/authentik_mfa.png) + +После успешного прохождения прошлых этапов мы получим список доступных сервисов: +![authentik_apps](images/SSO/authentik_apps.png) + + +## Внутренние сервисы + +### Gitea +В случае если у вас уже существует учетная запись в `Gitea` необходимо синкануть ее с вашей SSO учеткой. +Переходим в `Gitea` авторизируемся через Authentik. + +![gitea_sso](images/SSO/gitea_sso.png) + +Даем доступы на просмотр почты и инфы о вас. + +![gitea_sso_allow](images/SSO/gitea_sso_allow.png) + +И синкаем существующий акк с нашим SSO. + +![gitea_sso_sync](images/SSO/gitea_sso_sync.png) + + +### Netbird + +Аналогичную процедуру проделываем и с Netbird. Через Authentik переходим в Netbird и даем разрешение. + +![netbird_auth](images/SSO/netbird_auth.png) + +На что мы получим следующее сообщение: + +![netbird_allow_user](images/SSO/netbird_allow_user.png) + +Все отлично, теперь сообщаем Tech Lead или DevOps о необходимости аппрува вашего аккаунта. \ No newline at end of file diff --git a/docs/SSO/images/SSO/authentik_apps.png b/docs/SSO/images/SSO/authentik_apps.png new file mode 100644 index 0000000..1d4ab90 Binary files /dev/null and b/docs/SSO/images/SSO/authentik_apps.png differ diff --git a/docs/SSO/images/SSO/authentik_first_login.png b/docs/SSO/images/SSO/authentik_first_login.png new file mode 100644 index 0000000..254fcdc Binary files /dev/null and b/docs/SSO/images/SSO/authentik_first_login.png differ diff --git a/docs/SSO/images/SSO/authentik_mfa.png b/docs/SSO/images/SSO/authentik_mfa.png new file mode 100644 index 0000000..b30c6c6 Binary files /dev/null and b/docs/SSO/images/SSO/authentik_mfa.png differ diff --git a/docs/SSO/images/SSO/gitea_sso.png b/docs/SSO/images/SSO/gitea_sso.png new file mode 100644 index 0000000..112a990 Binary files /dev/null and b/docs/SSO/images/SSO/gitea_sso.png differ diff --git a/docs/SSO/images/SSO/gitea_sso_allow.png b/docs/SSO/images/SSO/gitea_sso_allow.png new file mode 100644 index 0000000..c840413 Binary files /dev/null and b/docs/SSO/images/SSO/gitea_sso_allow.png differ diff --git a/docs/SSO/images/SSO/gitea_sso_sync.png b/docs/SSO/images/SSO/gitea_sso_sync.png new file mode 100644 index 0000000..80ac2b2 Binary files /dev/null and b/docs/SSO/images/SSO/gitea_sso_sync.png differ diff --git a/docs/SSO/images/SSO/netbird_allow_user.png b/docs/SSO/images/SSO/netbird_allow_user.png new file mode 100644 index 0000000..911eecd Binary files /dev/null and b/docs/SSO/images/SSO/netbird_allow_user.png differ diff --git a/docs/SSO/images/SSO/netbird_auth.png b/docs/SSO/images/SSO/netbird_auth.png new file mode 100644 index 0000000..6fb1056 Binary files /dev/null and b/docs/SSO/images/SSO/netbird_auth.png differ