Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 3.95 KB

INSTALLATION.md

File metadata and controls

101 lines (66 loc) · 3.95 KB

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

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

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

    • Docker - во избежание ошибок желательно установить последнюю версию;
    • Git - для корректной работы требуется версия не ниже 2.41.0;

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

    git clone https://github.com/Security-Experts-Community/ERMACK.git

  3. Убедитесь, что вы находитесь в корневой папке проекта:

    cd ERMACK

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

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

    docker-compose up

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

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

    http://localhost:8000

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

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

    • Python - для корректной работы требуется версия не ниже 3.11;
    • Git - для корректной работы требуется версия не ниже 2.41.0;

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

    git clone https://github.com/Security-Experts-Community/ERMACK.git

  3. Убедитесь, что вы находитесь в корневой папке проекта:

    cd ERMACK

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

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

    python -m venv .venv

  6. Активируйте виртуальное окружение:

    • Для Windows:

      .venv\Scripts\activate.bat

    • Для Linux:

      source .venv/bin/activate

  7. Для установки всех зависимостей введите:

    pip install -r requirements.txt

  8. Запустите сборку проекта:

    python main.py mkdocs -i -a

  9. Перейдите в папку с результатами и запустите сервер:

    cd build
python -m mkdocs serve -a 0.0.0.0:8000

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

    http://localhost:8000