Как создать самостоятельно размещенное приложение GitHub
Если вы используете Bencher Cloud, то вы просто можете зарегистрироваться или войти в систему
с помощью кнопки GitHub.
Для Bencher Self-Hosted вам потребуется иметь Bencher Plus Enterprise план, создать собственное GitHub приложение и обновить вашу конфигурацию консоли и конфигурацию сервера API.
Создание приложения GitHub
- Создайте GitHub App
- Имя приложения GitHub
- Выберите уникальное имя (например:
Bencher для Моего Предприятия)
- Выберите уникальное имя (например:
- URL домашней страницы
- Установите его на URL вашей консоли Bencher Self-Hosted (например:
https://bencher.example.com)
- Установите его на URL вашей консоли Bencher Self-Hosted (например:
- Идентификация и авторизация пользователей
- URL для обратного вызова
- Установите URL обратного вызова на URL вашей консоли Bencher Self-Hosted с путем
/auth/github(например:https://bencher.example.com/auth/github)
- Установите URL обратного вызова на URL вашей консоли Bencher Self-Hosted с путем
- ✅ Истечение срока действия токенов авторизации пользователя
- ✅ Запрос авторизации пользователя (OAuth) во время установки
- ✅ Активация протокола подключения устройства
- URL для обратного вызова
- Webhook
- ❌ Активный - снимите эту галочку
- Права доступа
- Права доступа к аккаунту
- Адреса электронной почты:
Только для чтения
- Адреса электронной почты:
- Права доступа к аккаунту
- Где можно установить это приложение GitHub?
- 🔘 Любой аккаунт
- Нажмите
Создать приложение GitHub - Теперь в разделе
Общеедля новосозданного приложения - Заметьте
Client ID(например:Iv1.12864abcd1232048) - Секреты клиента
- Нажмите
Сгенерировать новый секрет клиента - Отметьте этот секрет (например:
00000abcd12345wxyz123456789abcdefgh0000)
- Нажмите
- Добавьте логотип Bencher в формате PNG в информацию для отображения
- Приватные ключи
- Нажмите
Сгенерировать приватный ключ
- Нажмите
Конфигурация приложения GitHub
Пользовательский интерфейс консоли
Установите переменную среды GITHUB_CLIENT_ID при запуске Docker образа bencher-console. (например: GITHUB_CLIENT_ID=Iv1.12864abcd1232048) Если отсутствует Client ID, то кнопки GitHub не появятся в пользовательском интерфейсе.
API Сервер
Добавьте client_id и client_secret в раздел plus.github конфигурации сервера. Если раздел GitHub отсутствует, то сервер не будет обрабатывать запросы аутентификации GitHub.
Связанные репозитории
Перед изменением этих настроек обновите API-сервер и консоль Bencher Self-Hosted до v0.6.16 или новее.
Чтобы Проект мог связать репозиторий GitHub для своих отсоединенных запусков, задайте также эти настройки приложения GitHub:
- Идентификация и авторизация пользователей
- URL для обратного вызова
- Установите первый URL обратного вызова на URL вашей консоли Bencher Self-Hosted с путем
/console/github(например:https://bencher.example.com/console/github). GitHub отправляет пользователя на первый URL обратного вызова после установки приложения. - Оставьте после него URL обратного вызова с путем
/auth/githubдля входа (например:https://bencher.example.com/auth/github). GitHub отклоняет вход, URL обратного вызова которого нет в списке.
- Установите первый URL обратного вызова на URL вашей консоли Bencher Self-Hosted с путем
- ✅ Запрос авторизации пользователя (OAuth) во время установки
- URL для обратного вызова
- Webhook
- ✅ Активный - поставьте эту галочку
- URL вебхука
- Установите его на URL вашего API-сервера Bencher Self-Hosted с путем
/v0/github/webhook(например:https://api.bencher.example.com/v0/github/webhook)
- Установите его на URL вашего API-сервера Bencher Self-Hosted с путем
- Секрет вебхука
- Введите случайный секрет и запишите его (например:
0123456789abcdef0123456789abcdef)
- Введите случайный секрет и запишите его (например:
- Права доступа
- Права доступа к репозиторию
- Содержимое:
Чтение и запись
- Содержимое:
- Подписка на события
- Оставьте все события неотмеченными
- Права доступа к репозиторию
- Запишите slug приложения, последнюю часть URL его публичной страницы (например:
my-bencher-appвhttps://github.com/apps/my-bencher-app)
Добавьте slug, приватный ключ и секрет вебхука как app в раздел plus.github конфигурации сервера.
🐰 Поздравляем! Вы научились настраивать приложение GitHub! 🎉