ConvertX 项目使用与配置教程

ConvertX 项目使用与配置教程

ConvertX 💾 Self-hosted online file converter. Supports 700+ formats 项目地址: https://gitcode.com/gh_mirrors/co/ConvertX

1. 项目目录结构及介绍

ConvertX 是一个开源的自托管在线文件转换器，支持超过一千种不同的文件格式。以下是项目的目录结构及其简要介绍：

ConvertX/
├── .github/             # GitHub 工作流配置目录
├── .vscode/            # VSCode 项目配置文件
├── images/             # 项目图像资源
├── public/             # 公共文件目录，如前端资源
├── src/                # 源代码目录
├── .dockerignore       # Docker 忽略文件
├── .gitignore          # Git 忽略文件
├── CHANGELOG.md        # 项目更新日志
├── Dockerfile          # Docker 构建文件
├── LICENSE             # 项目许可证
├── README.md           # 项目说明文件
├── SECURITY.md         # 项目安全政策
├── biome.json          # 项目生物群配置文件
├── bun.lock            # Bun 包管理器锁文件
├── compose.yaml        # Docker Compose 配置文件
├── eslint.config.ts    # ESLint 配置文件
├── package.json        # Node.js 项目配置文件
├── postcss.config.js   # PostCSS 配置文件
├── prettier.config.js  # Prettier 配置文件
├── renovate.json       # Renovate 配置文件
├── reset.d.ts          # TypeScript 重置声明文件
├── tsconfig.json       # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 Dockerfile 和 docker-compose.yaml 文件进行。

• Dockerfile：用于定义如何构建 ConvertX 的 Docker 镜像。
• docker-compose.yaml：用于定义如何部署 ConvertX 服务，包括服务名、使用的镜像、环境变量、端口映射等。

启动项目时，通常在项目根目录下运行以下命令：

docker-compose up -d

这将后台启动 ConvertX 服务。

3. 项目的配置文件介绍

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

• JWT_SECRET：用于签名 JSON Web Token 的字符串，提高安全性。
• ACCOUNT_REGISTRATION：是否允许用户注册账户。
• HTTP_ALLOWED：是否允许 HTTP 连接，仅本地开发时使用。
• ALLOW_UNAUTHENTICATED：是否允许未认证用户使用服务，仅本地开发时使用。
• AUTO_DELETE_EVERY_N_HOURS：自动删除超过指定时间的文件，设置为 0 可禁用。
• WEBROOT：设置网站的根路径。
• FFMPEG_ARGS：传递给 ffmpeg 的参数。

这些配置可以在 docker-compose.yaml 文件中的 environment 部分进行设置。

例如，设置 JWT_SECRET 和允许用户注册账户：

version: '3.8'
services:
  convertx:
    image: ghcr.io/c4illin/convertx:latest
    container_name: convertx
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - JWT_SECRET=yourLongAndSecretString
      - ACCOUNT_REGISTRATION=true
    volumes:
      - ./data:/app/data

确保替换 yourLongAndSecretString 为一个安全的字符串。

ConvertX 💾 Self-hosted online file converter. Supports 700+ formats 项目地址: https://gitcode.com/gh_mirrors/co/ConvertX