Перейти к основному содержимому

Локальная установка

Описанные ниже действия тестировались в среде с Windows 10 и не гарантируют работоспособность в другом окружении.

Перед установкой рекомендуется отключить ПО, которое потенциально может вступать в конфликт со средой выполнения проекта (прим.: OpenServer).

1. Docker Desktop и WSL (Windows Subsystem for Linux)​

  • В биосе необходимо включить поддержку виртуализации.

  • Если в системе не установлен Docker Desktop, устанавливаем его.

  • Скачиваем и устанавливаем подсистему Linux (описанные ниже шаги проверялись на дистрибутиве Ubuntu 22.04.2 LTS).

  • Запускаем Docker Desktop и заходим в его настройки, на вкладке General активируем Use the WSL 2 based engine:

Use the WSL 2 based engine

  • Затем переходим в раздел Resources > WSL Integration и активируем добавленный раннее дистрибутив:

Resources > WSL Integration

При возникновении проблем с DockerHub см. раздел для обхода блокировок.

2. Клонирование ядра системы​

Перед клонирование проекта убедитесь, что корректно настроены ssh-ключи.

При первичной установке проекта клонируется Evolutrix CRM — Core. Для корректной и быстрой работы проекта в локальной среде необходимо клонировать его в директорию установленного ранее Linux дистрибутива. В Windows 10 директория со всеми установленными Linux-подсистемами доступна по адресу \\wsl$. Таким образом, путь до директории с проектом должен иметь вид:

\\wsl.localhost\Ubuntu\home\ИМЯ_ПОЛЬЗОВАТЕЛЯ\projects\ant-crm.local.

В меню "Пуск" находим и запускаем приложение Ubuntu, в открывшемся терминале клонируем проект в эту папку:

git clone git@gitlab.develop.evolutrix.ru:evolutrix/ant-crm-core.git .\projects\ant-crm.local

3. Инициализация переменных окружения​

В корне проекта скопировать файл .env.example.dev в .env:

cp ".env.example.dev" ".env"

4. Настройка локального домена​

В hosts файл (C:\windows\system32\drivers\ets\hosts) необходимо добавить запись:

127.0.0.1 ant-crm.local

5. Запуск проекта​

Запуск dev-контейнера осуществляется командой из корня проекта:

docker compose -f docker-compose-dev.yml up -d

Для пересборки контейнера (в случае подключения дополнительных сервисов и/или редактирования конфигурационных файлов) к вышеуказанной команде добавляется флаг --build.

Если приложение запускается впервые, дополнительно в корне проекта следует выполнить:

bash initdev.sh
docker exec -it ant_app php artisan app:create-root-user root@example.com
docker exec -it ant_app php artisan app:set-modules "*"

Для заполнения БД тестовыми данными используйте раздел: Генерация тестовых данных в БД.

В случае корректной настройки проект будет доступен по адресу: http://ant-crm.local.

Остановка проекта:​

docker compose -f docker-compose-dev.yml down

Если вместе с остановкой контейнера требуется удалить примонтированные директории (volumes), к вышеуказанной команде добавляется флаг -v.