Перейти к основному содержимому
Версия: v1.0.x

Введение

Добро пожаловать 🎇 🎇 🎇

Шерлок предназначен для оптимизации процессов безопасной разработки за счет консолидации информации об ИБ-дефектах, получаемой из различных сканеров, и предоставления возможности централизованной одновременной работы с ними различными пользователями.

В документации описаны способы его установки, настройки и сведения о том, как пользоваться его возможностями.

Документация структурирована по разделам:

  • Установка Шерлока
    • Описание различных способов установки и запуска Шерлока
  • Настройка Шерлока
    • Описание настроек интеграций со сканерами, системами разработки (GitLab, Jira), подключение LDAP, управление пользователями и ролями
  • Работа с группами и проектами
    • Создание групп и проектов, настройка прав доступа, настройки интеграций со сканерами, системами разработки (GitLab, Jira), анализ рисков групп и проектов, работа с карточкой проектами
  • Работа с ИБ-дефектами
    • Сценарии импорта данных в Шерлока, возможные действия с ИБ-дефектами, описание карточек ИБ-дефектов, дашборды, история сканирований, настройка Security Gate и создание отчетов
  • Поиск ИБ-дефектов
    • Глобальный поиск ИБ-дефектов по всем проектам, существующим в Шерлоке
  • Логи
    • Получение сведений о том, что происходило в Шерлоке и кто это делал
  • Работа с API
    • Автоматизация действий при работе с Шерлоком
  • Функциональные характеристики
    • Общее описание возможностей Шерлока
  • Релизы
    • Информация о новых функциях, изменениях и доработках