Lab Dash 开源项目使用教程

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

Lab Dash 的目录结构如下所示：

lab-dash/
├── .github/
│   └── workflows/
├── .dockerignore
├── .gitignore
├── Dockerfile
├── LICENSE.md
├── README.md
├── docker-compose.yml
├── package.json

• .github/workflows/：包含项目的 GitHub Actions 工作流文件，用于自动化项目的构建、测试等流程。
• .dockerignore：Docker 构建时需要排除的文件和目录。
• .gitignore：Git 忽略文件列表，用于指定哪些文件和目录不应当被包含在版本控制中。
• Dockerfile：定义了如何构建 Lab Dash 的 Docker 镜像。
• LICENSE.md：项目的许可协议文件，本项目采用 MIT 许可。
• README.md：项目的自述文件，包含项目的基本信息和使用说明。
• docker-compose.yml：定义了如何使用 Docker Compose 来部署 Lab Dash。
• package.json：Node.js 项目的配置文件，定义了项目的依赖和脚本。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置和启动。以下是 docker-compose.yml 的基本内容：

version: '3'
services:
  lab-dash:
    container_name: lab-dash
    image: ghcr.io/anthonygress/lab-dash:latest
    privileged: true
    ports:
      - "2022:2022"
    environment:
      - SECRET=YOUR_SECRET_KEY
    volumes:
      - /sys:/sys:ro
      - /docker/lab-dash/config:/config
      - /docker/lab-dash/uploads:/app/public/uploads
      - /var/run/docker.sock:/var/run/docker.sock
    restart: unless-stopped
    labels:
      - "com.centurylinklabs.watchtower.enable=true"

在这个文件中，我们定义了一个名为 lab-dash 的服务，使用 ghcr.io/anthonygress/lab-dash:latest 镜像，映射了容器的端口到宿主机的端口，并设置了环境变量和卷映射。

要启动项目，你需要在项目根目录下运行以下命令：

docker-compose up -d

这将以后台模式启动 Lab Dash 服务。

3. 项目的配置文件介绍

项目的配置主要通过环境变量来进行。在 docker-compose.yml 文件中，你可以看到以下环境变量配置：

environment:
  - SECRET=YOUR_SECRET_KEY

这里定义了一个 SECRET 环境变量，用于 JWT 加密。你需要替换 YOUR_SECRET_KEY 为你自己生成的随机字符串。

此外，项目还支持通过卷映射来覆盖默认的配置文件。在 docker-compose.yml 文件中，配置了以下卷映射：

volumes:
  - /docker/lab-dash/config:/config

这意味着你可以通过在宿主机的 /docker/lab-dash/config 目录下放置配置文件来覆盖容器内的默认配置。这对于自定义 Lab Dash 的行为非常有用。