GitSave开源项目安装与配置指南

1. 项目基础介绍

GitSave 是一个自托管的开源应用程序，用于备份 Git 仓库。它提供了定时备份功能，支持 GitHub、GitLab 等多种 Git 平台。GitSave 通过一个简单易用的 Web 界面进行操作，非常适合需要定期备份 Git 仓库的开发者。

主要编程语言：TypeScript 和 Astro。

2. 关键技术与框架

• TypeScript：一种由微软开发的开源编程语言，它是 JavaScript 的一个超集，为 JavaScript 提供了可选的静态类型和基于类的面向对象编程。
• Astro：一个快速、现代的网站构建框架，它允许开发者使用各种前端技术构建网站，同时保持轻量级和性能。
• Docker：一种开源的应用容器引擎，可以打包、发布和运行应用。
• JWT (JSON Web Token)：一种用于双方之间传递安全可靠信息的简洁的、URL安全的表达方式。

3. 安装和配置准备工作及详细步骤

准备工作

• 确保您的系统中已安装 Docker。
• 准备好一个 SMB 共享或本地目录用于存储备份文件。

安装步骤

步骤 1：设置环境变量

在开始之前，您需要生成两个安全密钥：JWT_SECRET 和 ENCRYPTION_SECRET。您可以使用在线工具生成这些密钥，确保 ENCRYPTION_SECRET 是 32 个字符长。

步骤 2：运行 Docker 容器

使用以下命令运行 GitSave 的 Docker 容器：

docker run -d --restart=always -p 3000:3000 -v gitsave:/app/data -v ./backups:/app/backups -e JWT_SECRET={您的JWT_SECRET} -e ENCRYPTION_SECRET={您的ENCRYPTION_SECRET} -e DISABLE_AUTH=false --name GitSave timwitzdam/gitsave:latest

请将 {您的JWT_SECRET} 和 {您的ENCRYPTION_SECRET} 替换为您生成的密钥。

步骤 3：配置 Docker Compose（可选）

如果您更喜欢使用 Docker Compose，可以按照以下步骤操作：

1. 创建一个 .env 文件，并添加以下内容：

JWT_SECRET=您的JWT_SECRET
DISABLE_AUTH=false
ENCRYPTION_SECRET=您的ENCRYPTION_SECRET

2. 创建一个 docker-compose.yml 文件，并添加以下内容：

version: '3.8'
services:
  gitsave:
    image: timwitzdam/gitsave:latest
    container_name: GitSave
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - gitsave:/app/data
      - ./backups:/app/backups
    environment:
      - JWT_SECRET=${JWT_SECRET:?error}
      - DISABLE_AUTH=${DISABLE_AUTH:?error}
      - ENCRYPTION_SECRET=${ENCRYPTION_SECRET:?error}
    volumes:
      gitsave:

3. 在同一目录下运行 docker-compose up -d 命令来启动服务。

步骤 4：访问 GitSave

安装完成后，您可以通过浏览器访问 http://localhost:3000 来使用 GitSave。您需要使用 Docker 容器内部的 SMB 共享或本地目录来存储备份文件。

遵循以上步骤，您应该能够成功安装并配置 GitSave。如果有任何问题，可以查看项目的 README 文件或在 GitHub 上提出问题。