Приложение имеет БД, которая используется для сохранения состояния отслеживаемых сущностей GitLab.
+
+
+
+Схема приложения версия 1.0.0
+
+
Важно подчеркнуть, что приложение не сохраняет все бездумно в БД. Во время первого запуска вам будет задан ряд вопросов, ответы на которые повлияют на наполнение БД.
+
Также приложение старается не хранить лишние данные. Например, если MR был вмержен или закрыт, то нет смысла хранить информацию об этом MR, поэтому при следующем сканировании запись об этом MR, а также обо всех связанных сущностях этого MR (пайплайны, треды...) будут удалены.
Раз в 1 минуту происходит обращение к GitLab API с вашим персональным токеном. Получаемые от GitLab данные сверяются с имеющимися в БД, после чего формируются уведомления, если обнаружены изменения.
+
+
Почему не использовать Webhook?
+
Не везде имется возможность установить произвольные Webhook. Например, вряд ли кто-то позволит вам установить Webhook из корпоративного GitLab во внешнюю сеть. Переодическое обращение к GitLab API можно выполнять прямо с рабочей машины.
GitLab Notification – Персональный Telegram для GitLab¶
-
Персональный помощник для взаимодействия с GitLab. Получайте уведомления о событиях в GitLab: новые MR, где вы ревьювер, конфликты в ваших MR, уведомления о новых сообщениях в тредах, где вы являетесь участником, и многое другое.
Мое решение сфокусировано на приватности и прозрачности. Код и используемые зависимости полностью открыты и доступны для изучения и самостоятельной сборки.
-
Для работы бота токен доступа устанавливается в переменные среды и никуда не передается, кроме запросов в GitLab.
-
Некоторые уведомления могут содержать чуствительную информацию. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о ваших репозиториях Телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений.
-
Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом коментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске.
+
GitLab Notification – Персональный Telegram бот для GitLab⚓︎
+
Запустите своего личного GitLab бота и получайте персональные уведомления из GitLab прямо на свой аккаунт в Telegram! Это не облачное решение, бот запускается на вашей машине или вашем сервере.
+
Вы больше никогда не пропустите важное уведомление. Будь то новый запрос на слияние или возникновение конфликта. Больше не нужно заходить в GitLab, чтобы проверить статус сборки - с нашим приложением вы сможете оставаться в курсе дел, где бы вы ни находились.
+
Бота легко настроить и использовать, а быстрые действия призваны оптимизировать ваш рабочий процесс. Не ждите больше - запустите своего персонального Telegram бота, и получайте персональные уведомления о событиях в GitLab.
Я понимаю, что в GitLab содержится множество конфиденциальной информации, которую не хотелось бы раскрывать. Эта страница пытается ответить на все вопросы, которые могут вас смущать.
Давайте знакомится. Меня зовут Стручков Марк, я тимлид небольшой команды. В свободное время веду блог и "блокнот." Это приложение в первую очередь должно помогать мне работать, оптимизируя мое взаимодействие с GitLab.
+
В какой-то момент я решил подлиться своими наработками со всеми желающими. И пытаться кому-то что-то доказать у меня нет желания. Что-то смущает? Не пользуйтесь. В этом весь Open Source.
На мой взгляд довольно очевидно, что если бы я преднамеренно замышлял какую-нибудь пакость, то не стал бы делать это от своего имени. Однако некоторые вектора атаки существуют, и я постараюсь описать их на этой странице.
Для работы ассистента необходим персональный токен GitLab. Достаточно токена с правами только на чтение. Он указывается в переменные среды и нигде дополнительно не хранится и не передается. Таким образом токен не попадает в Telegram, никуда не передается, и хранится только у вас на компьютере и в контейнере приложения.
+
Токен используется только при обращении к указанному GitLab, и только для выполнения описанных в документации возможностей. Никакой скрытой работы не выполняется, по возможности обо всех взаимодействиях с GitLab дополнительно сообщается в диалоговом режиме, особенно во время первичной настройки.
+
+
А что, если ты украдешь токен?
+
Я еще раз повторяю, что в мои планы не входит что-то кому-то доказывать. Это open source, детка, изучайте код и позорьте мое честное имя перед сообществом, если что-то найдете.
+
Задайте себе вопрос: насколько полезен токен от вашего корпоративного self-host гитлаба без подключения к корпоративному VPN.
Некоторые уведомления могут содержать множество чувствительной информации. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о вашей разработке телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений.
+
Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом комментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске.
Для работы ассистента ему нужно сохранять предыдущее состояние GitLab сущностей. Для этого используется БД. Приложение старается не хранить в БД больше данных, чем необходимо. Как только необходимость в данных теряется, например MR мержится, данные из БД удаляются.
Все боты в Telegram являются публичными. Это значит, что ваш бот может быть найден через поиск в Telegram. Поэтому не рекомендуется давать название боту, которое может раскрыть его предназначение.
+
Даже если кто-то случайно напишет вашему боту ничего не случится. В боте встроена проверка прав доступа. Вот как она работает:
+
+
При запуске вы указываете ваш идентификатор в Telegram. В отличие от логина, идентификатор уникален для каждого пользователя и нет возможности его подменить.
+
Когда бот получает сообщение, он проверяет идентификатор отправителя
+
Если идентификатор отправителя не совпадает с указанным при запуске, бот не обрабатывает команду
+
Вы получаете уведомление о том, что такой-то пользователь пытался написать в ваш бот. Вам доступен логин этого пользователя в Telegram, а также текст его сообщения. Это поможет понять является ли попытка доступа злонамеренной и принять меры.
+
+
+
+
+уведомление о несанкционированном доступе
+
+
Для злоумышленника все выглядит так, как будто бот не работает. Никаких ответных сообщений ему не отправляется.
Если ваш Telegram аккаунт взломают, то взломщику станет доступна вся переписка с ботом. Поэтому рекомендую нажимать на быстрое действие о просмотре сообщения (), а также периодически удалять историю переписки.
+
+
+
+
+
+
+
+
+
+
+
+
Комментарии
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/gitlab-notification/ru/latest/privacy/unauth-access.png b/gitlab-notification/ru/latest/privacy/unauth-access.png
new file mode 100644
index 0000000..263a505
Binary files /dev/null and b/gitlab-notification/ru/latest/privacy/unauth-access.png differ
diff --git a/gitlab-notification/ru/latest/search/search_index.json b/gitlab-notification/ru/latest/search/search_index.json
index 2feae5c..9b7a488 100644
--- a/gitlab-notification/ru/latest/search/search_index.json
+++ b/gitlab-notification/ru/latest/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["ru"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"GitLab Notification \u2013 \u041f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u0439 Telegram \u0434\u043b\u044f GitLab","text":"
"},{"location":"getting-started/configuration/#idea","title":"\u0417\u0430\u043f\u0443\u0441\u043a \u0432 IDEA","text":""},{"location":"getting-started/configuration/#jar","title":"\u0417\u0430\u043f\u0443\u0441\u043a JAR \u0440\u0435\u043b\u0438\u0437\u0430","text":"
"}]}
\ No newline at end of file
+{"config":{"lang":["ru"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"GitLab Notification \u2013 \u041f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u0439 Telegram \u0431\u043e\u0442 \u0434\u043b\u044f GitLab","text":"
Спонсорская поддержка делает проект устойчивым, так как она окупает время сопровождающих этого проекта - очень дефицитный ресурс, который тратится на разработку новых функций, исправление ошибок, повышение стабильности, решение проблем и общую поддержку. Самое большое узкое место в Open Source - это время.
+
В будущем планируется появление платной версии бота с большим количеством дополнительного функционала. Возможно ранним донатерам сделаем скидку на подписку
+
+
Вы можете выбрать любой удобный способ поддержки разработки:
+ 
Защита данных⚓︎
+ 
), а также периодически удалять историю переписки.
Поддержать разработку