CoreControl 项目使用教程

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

CoreControl 项目的目录结构如下：

• agent/: 包含了用于收集服务器信息的 agent 服务的代码。
• app/: 包含了 CoreControl 应用的主要代码，包括前端界面和后端服务。
• components/: 存放项目中使用的组件。
• hooks/: 存放自定义的 React 钩子。
• lib/: 存放项目依赖的库和工具。
• prisma/: 包含了 Prisma ORM 的配置和模型定义。
• public/: 存放公共静态文件，如图片、CSS 文件等。
• .dockerignore: 指定 Docker 构建时需要忽略的文件和目录。
• .gitignore: 指定 Git 提交时需要忽略的文件和目录。
• Dockerfile: 用于构建 CoreControl 的 Docker 容器镜像。
• LICENSE: 项目的许可文件，本项目采用 MIT 许可。
• README.md: 项目的自述文件，包含项目的基本信息和说明。
• components.json: 可能包含组件相关的配置信息。
• compose.yml: Docker Compose 文件，用于定义和运行多容器 Docker 应用。
• next.config.ts: Next.js 的配置文件。
• package-lock.json: 包含项目依赖的精确版本信息。
• package.json: 包含项目的元数据和脚本。
• postcss.config.mjs: PostCSS 的配置文件。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 Docker Compose 进行，使用 compose.yml 文件定义了以下几个服务：

• web: CoreControl 应用的主服务，包括前端和后端。
• agent: 用于收集服务器信息的 agent 服务。
• db: PostgreSQL 数据库服务。

启动项目的命令为：

docker-compose up

这条命令会启动所有定义在 compose.yml 文件中的服务。

3. 项目的配置文件介绍

项目的配置主要通过环境变量进行，以下是一些主要的配置项：

• LOGIN_EMAIL: 设置管理员的登录邮箱。
• LOGIN_PASSWORD: 设置管理员的登录密码。
• JWT_SECRET: 设置 JSON Web Token 的密钥。
• ACCOUNT_SECRET: 设置账户相关的密钥。
• DATABASE_URL: 设置数据库的连接字符串。

这些环境变量可以在 compose.yml 文件中的环境部分设置，或者在运行 Docker 容器时通过 -e 参数传递。

此外，prisma/ 目录下的 schema.prisma 文件定义了数据库的模型和关系，可以通过 Prisma 工具进行数据库的迁移和生成相应的 ORM 代码。