第2章 参与 Hestia 开发
第2章 参与 Hestia 的开发
Hestia 是一个开源项目,欢迎社区贡献。参与前请先阅读贡献指南。
Hestia 设计上安装于 Web 服务器。如果要在本地机器上开发,建议使用虚拟机。
警告
开发版本不稳定。如遇 Bug,请通过 GitHub 提交 Issue 或 Pull Request。
创建用于开发的虚拟机
以下是在虚拟机中运行 Hestia 进行开发的示例步骤。
这些步骤使用 Multipass 创建 Ubuntu 虚拟机。你也可以根据自己惯用的虚拟化软件调整命令。
1. 为你的操作系统安装 Multipass
2. Fork Hestia 并把仓库克隆到本地
```bash git clone https://github.com/YourUsername/hestiacp.git ~/projects ```
3. 创建一个至少 2GB 内存、15GB 磁盘空间的 Ubuntu 虚拟机(如果在 ARM 架构上运行,例如 Apple M1,内存至少 12GB)
```bash multipass launch --name hestia-dev --memory 4G --disk 15G --cpus 4 ```
4. 把克隆下来的仓库挂载到虚拟机的 home 目录
```bash multipass mount ~/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp ```
5. 以 root 身份 SSH 进入虚拟机,安装必要的软件包
```bash multipass exec hestia-dev -- sudo bash sudo apt update && sudo apt install -y jq libjq1 ```
6. 进入虚拟机的 /src 目录,编译 Hestia 软件包
```bash cd src ./hst_autocompile.sh --all --noinstall --keepbuild '~localsrc' ```
7. 进入 /install 目录,使用以下参数安装 Hestia(参数可按需调整,登录凭据也在这里设置)
```bash cd ../install bash hst-install-ubuntu.sh --hostname demo.hestiacp.com --email [email protected] --username admin --password Password123 --with-debs /tmp/hestiacp-src/deb/ --interactive no --force ```
8. 重启虚拟机(同时退出 SSH 会话)
```bash reboot ```
9. 在本地机器上查看虚拟机的 IP 地址(等虚拟机重启完成,IP 才会出现)
```bash multipass list ```
10. 在浏览器中使用默认端口访问虚拟机 IP,用 admin/Password123 登录(加载页面时如出现 SSL 错误,直接继续访问即可),例如 https://192.168.64.15:8083
至此 Hestia 已经在虚拟机中运行。如果想在浏览器中修改源码并测试效果,请继续阅读下一节。
警告
使用 Multipass 时,本地源码目录与虚拟机内目录的挂载有时会失效,并报"failed to obtain exit status for remote process"错误。此时只需卸载后重新挂载即可:
```bash multipass unmount hestia-dev multipass mount ~/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp ```
修改 Hestia 代码
在虚拟机中搭好 Hestia 后,就可以在本地机器(虚拟机外)用你喜欢的编辑器修改 ~/projects/hestiacp 下的源码了。
以下以修改 Hestia 的 UI 为例,介绍如何运行构建脚本并在本地测试。
1. 在本地机器上修改一个容易验证的文件,例如把 web/css/src/base.css 中的 body 背景色改成红色
2. 以 root 身份 SSH 进入虚拟机并进入 /src 目录
```bash multipass exec hestia-dev -- sudo bash cd src ```
3. 运行 Hestia 构建脚本
```bash ./hst_autocompile.sh --hestia --install '~localsrc' ```
4. 在浏览器中刷新页面查看改动
提交代码修改供审核的详细说明,请参考贡献指南。
提示
每次运行 Hestia 构建脚本都会创建备份,频繁运行会占满虚拟机的磁盘空间。可以以 root 身份执行 rm -rf /root/hst_backups 来清理备份。
运行自动化测试
我们目前使用 Bats 运行自动化测试。
安装
```bash # 克隆 Hestia 仓库(含测试子模块) git clone --recurse-submodules https://github.com/hestiacp/hestiacp # 或者使用已有的本地仓库(main 分支保持最新) git submodule update --init --recursive
# 安装 Bats test/test_helper/bats-core/install.sh /usr/local ```
运行
危险
切勿在生产服务器上运行任何测试脚本,可能导致故障或停机!
```bash # 运行 Hestia 测试 test/test.bats