Scriberr 项目使用教程

Scriberr 项目使用教程

Scriberr Self-hosted AI audio transcription 项目地址: https://gitcode.com/gh_mirrors/sc/Scriberr

1. 项目目录结构及介绍

Scriberr 是一个自托管的 AI 音频转录应用，项目目录结构如下：

Scriberr/
├── .dockerignore
├── .env
├── .gitignore
├── .npmrc
├── .prettierrc
├── Dockerfile
├── Dockerfile-gpu
├── LICENSE
├── README.md
├── components.json
├── docker-compose.yml
├── docker-compose.gpu.yml
├── drizzle/
│   ├── drizzle.config.ts
│   └── drizzle-compose.yml
├── env.example
├── eslint.config.js
├── package-lock.json
├── package.json
├── postcss.config.js
├── requirements.txt
├── svelte.config.js
├── tailwind.config.js
├── transcribe.py
├── transcript.json
└── tsconfig.json

• .dockerignore: 指定不需要打包进 Docker 镜像的文件和目录。
• .env: 环境变量配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• Dockerfile: Docker 构建文件，用于构建 CPU 版本的镜像。
• Dockerfile-gpu: Docker 构建文件，用于构建 GPU 版本的镜像。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• components.json: 组件配置文件。
• docker-compose.yml: Docker Compose 文件，用于定义和运行多容器 Docker 应用。
• docker-compose.gpu.yml: Docker Compose 文件，用于定义和运行带有 GPU 支持的多容器 Docker 应用。
• drizzle/: 包含 Drizzle 相关配置和文件。
• env.example: 环境变量示例配置文件。
• eslint.config.js: ESLint 配置文件，用于代码质量检查。
• package-lock.json: npm 包锁文件。
• package.json: npm 包配置文件。
• postcss.config.js: PostCSS 配置文件。
• requirements.txt: Python 依赖文件。
• svelte.config.js: Svelte 配置文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• transcribe.py: 音频转录 Python 脚本。
• transcript.json: 转录结果 JSON 文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 Docker 和 Docker Compose 来完成的。

• docker-compose.yml 或 docker-compose.gpu.yml: 根据是否需要 GPU 支持，选择相应的 Docker Compose 文件启动项目。这些文件定义了项目所需的服务和容器。

启动命令如下：

docker-compose up -d

或者对于 GPU 版本：

docker-compose -f docker-compose.gpu.yml up -d

这将启动所有定义的服务，并后台运行。

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件进行。

• .env: 包含了项目运行所需的环境变量，如管理员用户名 (ADMIN_USERNAME) 和密码 (ADMIN_PASSWORD)，以及 OpenAI API Key (OPENAI_API_KEY) 等。

示例配置如下：

ADMIN_USERNAME=admin
ADMIN_PASSWORD=yourpassword
OPENAI_API_KEY=yourapikey

在启动项目之前，需要根据实际情况编辑 .env 文件，设置正确的环境变量值。

Scriberr Self-hosted AI audio transcription 项目地址: https://gitcode.com/gh_mirrors/sc/Scriberr