Вклад в разработку Hestia ​

Hestia — проект с открытым исходным кодом, и мы приветствуем вклад сообщества. Пожалуйста, прочтите руководство по вкладу для получения дополнительной информации.

Hestia предназначена для установки на веб-сервер. Для разработки Hestia на локальном компьютере рекомендуется виртуальная машина.

Создание виртуальной машины для разработки ​

Это примеры инструкций по созданию виртуальной машины, на которой запущена Hestia для разработки.

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

multipass unmount hestia-dev
multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp

1. Установите Multipass для вашей ОС.

2. Fork Hestia и клонируйте репозиторий на локальную машину

git clone https://github.com/YourUsername/hestiacp.git $HOME/projects

1. Создайте виртуальную машину Ubuntu с объемом памяти не менее 2 ГБ и дисковым пространством 15 ГБ

multipass launch --name hestia-dev --memory 2G --disk 15G

1. Сопоставьте клонированный репозиторий с домашним каталогом виртуальной машины

multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp

1. Подключитесь к виртуальной машине по SSH как root и установите некоторые необходимые пакеты

multipass exec hestia-dev -- sudo bash
sudo apt update && sudo apt install -y jq libjq1

1. За пределами виртуальной машины (в новом терминале) убедитесь, что установлен Node.js 16 или более поздней версии

node --version

1. Установите зависимости и соберите файлы темы:

npm install
npm run build

1. Вернитесь в терминал виртуальной машины, перейдите в /src и соберите пакеты Hestia

cd src
./hst_autocompile.sh --hestia --noinstall --keepbuild '~localsrc'

1. Перейдите в /install и установите Hestia

(обновите install flags по своему вкусу, обратите внимание, что учетные данные для входа задаются здесь)

cd ../install
bash hst-install-ubuntu.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password Password123 --hostname demo.hestiacp.com -f

1. Перезагрузите ВМ (и выйдите из сеанса SSH)

reboot

1. Найдите IP-адрес ВМ

multipass list

1. Перейдите по IP-адресу ВМ в своем браузере, используя порт Hestia по умолчанию, и войдите с помощью admin/Password123

(пропустите любые ошибки SSL, которые вы видите при загрузке страницы)

например https://192.168.64.15:8083

Hestia теперь работает на виртуальной машине. Если вы хотите внести изменения в исходный код и протестировать их в браузере, перейдите к следующему разделу.

Внесение изменений в Hestia ​

После настройки Hestia на виртуальной машине вы теперь можете вносить изменения в исходный код в $HOME/projects/hestiacp на локальной машине (вне виртуальной машины) с помощью редактора по вашему выбору.

Ниже приведены примеры инструкций по внесению изменений в пользовательский интерфейс Hestia и его локальному тестированию.

1. В корне проекта на локальной машине убедитесь, что установлены последние пакеты

npm install

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

например измените цвет фона тела на красный в web/css/src/base.css, затем запустите:

npm run build

1. Подключитесь к виртуальной машине по SSH как root и перейдите в /src

multipass exec hestia-dev -- sudo bash
cd src

1. Запустите скрипт сборки Hestia

./hst_autocompile.sh --hestia --install '~localsrc'

1. Перезагрузите страницу в браузере, чтобы увидеть изменения

Дополнительную информацию об отправке изменений кода на проверку см. в руководстве по внесению изменений.

Запуск автоматизированных тестов ​

В настоящее время мы используем Bats для запуска наших автоматизированных тестов.

Установка ​

# Клонирование репозитория Hestia с тестовыми подмодулями
git clone --recurse-submodules https://github.com/hestiacp/hestiacp
# Или использование существующего локального репозитория с актуальной основной веткой
git submodule update --init --recursive

# Установка Bats
test/test_helper/bats-core/install.sh /usr/local

Запуск ​

# Запуск тестов Hestia
test/test.bats