Lab-Dash 安装与配置指南

1. 项目基础介绍

Lab-Dash 是一个开源的用户界面，旨在为您的家庭实验室或服务器提供一个内部或外部托管的起始页面。它拥有一个可定制的网格布局，允许添加各种小工具，如服务链接、系统信息、服务健康检查和自定义小工具等。

该项目的主要编程语言是 TypeScript 和 JavaScript。

2. 项目使用的关键技术和框架

• React: 用于构建用户界面的 JavaScript 库。
• Node.js: 服务端 JavaScript 运行环境。
• Docker: 用于打包和运行应用容器的平台。
• TypeScript: 是 JavaScript 的一个超集，添加了类型系统。
• Docker Compose: 用于定义和运行多容器 Docker 应用程序的工具。

3. 项目安装和配置的准备工作

在开始安装前，请确保您的系统已满足以下要求：

• 已安装 Docker。
• 已安装 Docker Compose。
• 确保您的服务器具有静态 IP 地址，以便局域网或广域网中的任何设备都能访问 Lab-Dash 实例。

详细安装步骤

1. 克隆项目仓库

   打开命令行界面，运行以下命令克隆项目仓库：

   git clone https://github.com/AnthonyGress/lab-dash.git
   cd lab-dash
   

2. 设置环境变量

   在项目目录中创建一个 .env 文件，并设置一个随机字符串作为 JWT 加密密钥：

   echo "SECRET=YOUR_SECRET_KEY" > .env
   

   其中 YOUR_SECRET_KEY 需要替换为您自己的随机字符串。

3. 运行 Docker Compose 文件

   在项目目录中，使用以下命令启动应用：

   docker-compose up -d
   

   这将启动 Docker 容器，并在后台运行。

4. 访问 Lab-Dash

   在浏览器中输入以下地址，以访问您的 Lab-Dash 实例：

   http://localhost:2022
   

   或者使用您的服务器本地 IP 地址或托管 URL。

5. 停止 Docker 容器

   如果需要停止 Lab-Dash 实例，可以运行以下命令：

   docker-compose down
   

6. 本地开发

   如果您希望在本地开发，可以运行以下命令安装依赖并启动开发服务器：

   npm install
   npm run dev
   

7. 更新 Lab-Dash

   当有新版本可用时，可以按照以下步骤更新：

   • 使用 Portainer 进行更新：在 Portainer 中找到 lab-dash 栈，点击编辑，然后更新栈，并确保勾选了“重新拉取镜像并重新部署”。
   • 使用 Docker CLI 进行更新：先停止并移除当前容器，然后拉取最新镜像并重新启动容器。

   cd /directory_of_compose_yaml
   docker-compose down
   docker-compose pull
   docker-compose up -d
   

请确保按照上述步骤操作，以顺利完成 Lab-Dash 的安装和配置。