Skip to content

Сборка базы знаний и запуск представления в формате MKDocs

Запуск локальной копии базы знаний в Docker

  1. Убедитесь, что у вас установлен и запущен Docker на вашей ОС, а также git. Процесс установки подробно описан для различных ОС на официальных сайтах:
  2. Docker - во избежание ошибок желательно установить последнюю версию;
  3. Git - для корректной работы требуется версия не ниже 2.41.0;

  4. Скачайте репозиторий проекта, для этого откройте терминал или командную строку и выполните команду:

    git clone https://github.com/Security-Experts-Community/ERMACK.git
    
  5. Убедитесь, что вы находитесь в корневой папке проекта:

    cd ERMACK
    
  6. Отредактируйте или создайте файл с профилем инфраструктуры (этот шаг можно пропустить)

  7. Запустите контейнер, выполнив команду:

    docker-compose up
    

(Docker должен начать скачивать образ ERMACK и его зависимости)

  1. После успешного запуска контейнера, откройте браузер и введите следующий адрес:

    http://localhost:8000
    

Запуск локальной копии базы знаний в виртуальном окружении Python

  1. Убедитесь, что на вашей ОС установлены git, Python и Pip. Процесс установки подробно описан для различных ОС на официальных сайтах:
  2. Python - для корректной работы требуется версия не ниже 3.11;
  3. Git - для корректной работы требуется версия не ниже 2.41.0;

  4. Скачайте репозиторий проекта, для этого откройте терминал или командную строку и выполните команду:

    git clone https://github.com/Security-Experts-Community/ERMACK.git
    
  5. Убедитесь, что вы находитесь в корневой папке проекта:

    cd ERMACK
    
  6. Для инстанцирования действий внутри сценариев реагирования требуется создать файл с профилем инфраструктуры (этот шаг можно пропустить)

  7. Установите виртуальное окружение:

    python -m venv .venv
    
  8. Активируйте виртуальное окружение:

  9. Для Windows:

    .venv\Scripts\activate.bat
    
  10. Для Linux:

    source .venv/bin/activate
    
  11. Для установки всех зависимостей введите:

    pip install -r requirements.txt
    
  12. Запустите сборку проекта:

    python main.py mkdocs -i -a
    
  13. Перейдите в папку с результатами и запустите сервер:

    cd build
    python -m mkdocs serve -a 0.0.0.0:8000
    
  14. После успешного запуска сервера, откройте браузер и введите следующий адрес:

    http://localhost:8000