ZaneOps 项目使用教程

ZaneOps 项目使用教程

zane-ops A self-hosted PaaS for your web services, databases, CRONs, and everything you need for your next startup. 项目地址: https://gitcode.com/gh_mirrors/za/zane-ops

1. 项目的目录结构及介绍

ZaneOps 是一个开源的自托管平台，用于托管静态网站、Web 应用、数据库、服务（如 Supabase、WordPress、Ghost）、工作者或您启动初创公司或管理企业所需的任何内容。项目的目录结构如下：

• .github/：包含与 GitHub 相关的配置文件，如工作流（Workflows）。
• .vscode/：包含 Visual Studio Code 的配置文件。
• backend/：后端代码目录。
• docker/：Docker 配置文件和 Dockerfile。
• frontend/：前端代码目录。
• images/：存储项目相关图像的目录。
• openapi/：开放 API 相关的代码或配置。
• .dockerignore：Docker 忽略文件，用于指定不应被 Docker build 包括的文件和目录。
• .env.template：环境变量模板文件。
• .gitignore：Git 忽略文件，用于指定不应被 Git 跟踪的文件和目录。
• CODE_OF_CONDUCT.md：项目行为准则。
• CONTRIBUTING.md：贡献指南。
• Dockerfile.front：前端 Dockerfile。
• LICENSE：项目许可证文件。
• Makefile：Makefile 文件，用于定义构建和部署任务。
• README.md：项目自述文件。
• biome.json：项目配置文件。
• deploy.mk：部署相关的 Makefile。
• healthcheck-strategy.md：健康检查策略文档。
• package.json：Node.js 项目配置文件。
• pnpm-lock.yaml：pnpm 锁文件。
• pnpm-workspace.yaml：pnpm 工作空间配置文件。
• pyrightconfig.json：Pyright 配置文件。
• reset-db.sh：数据库重置脚本。
• spinner.sh：命令行进度指示器脚本。

2. 项目的启动文件介绍

项目的启动主要通过 Makefile 文件定义的任务来实现。以下是启动项目的基本步骤：

# 创建一个文件夹用于安装 ZaneOps
mkdir -p /var/www/zaneops
cd /var/www/zaneops

# 下载 ZaneOps "cli"
curl https://cdn.zaneops.dev/makefile > Makefile

# 设置和部署项目
make setup
make deploy

在完成上述步骤后，Makefile 中的 setup 和 deploy 任务会被执行，从而完成项目的启动。

3. 项目的配置文件介绍

项目的配置主要通过 .env.template 和 biome.json 文件进行。.env.template 文件是环境变量的模板，它包含了项目运行所需的环境变量。您需要根据实际情况填写相应的值，并将其重命名为 .env 文件。

biome.json 文件是项目的主配置文件，它包含了项目的全局设置，如数据库配置、服务配置等。

请确保在开始之前正确配置这些文件，否则项目可能无法正确运行。

zane-ops A self-hosted PaaS for your web services, databases, CRONs, and everything you need for your next startup. 项目地址: https://gitcode.com/gh_mirrors/za/zane-ops