目录

• 目录
• 项目简介
  • 技术栈
• 快速入门
  • 先决条件
  • 安装
  • 修改用户权限
  • 已知限制
• 贡献
  • 数据迁移
• 赞助商
• 许可证

项目简介

我们的目标是打造一个平台，让人们可以分享自己的 Stable Diffusion 模型（如文本反演、超网络、美学梯度、VAE 等用于定制 AI 生成内容的各种创新方法），与他人协作改进这些模型，并相互学习。该平台允许用户创建账户、上传模型，以及浏览他人分享的模型。用户还可以对彼此的模型发表评论和反馈，以促进协作和知识共享。

技术栈

我们使用了一系列现代 Web 技术构建了这个项目，包括 Next.js 作为前端框架、TRPC 作为 API 层，以及 Prisma 和 Postgres 作为数据库。通过这些工具的结合使用，我们成功构建了一个既易于使用又功能强大的可扩展且易于维护的平台。

• 数据库: Prisma + Postgres
• API: tRPC
• 前后端: NextJS
• UI 框架: Mantine
• 存储: Cloudflare

快速入门

要将本地副本运行起来，请按照以下步骤操作。

先决条件

首先，请确保您的机器上已安装以下软件：

• Docker（用于运行数据库和服务）
• 如果使用开发容器：
  • 支持开发容器的 IDE（例如 VS Code 配合 Dev Containers 扩展、JetBrains 等）
• 如果直接在本地运行：
  • Node.js（版本 20 或更高）
    • 建议您安装 nvm 来管理 Node.js 版本，以便正确配置运行该项目所需的 Node.js 版本。

      curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
      

  • Make（可选，便于初始设置）

安装

1. 按照上述【先决条件】中的步骤进行准备。
2. 将仓库克隆到您的本地机器。
3. 选择以下其中一种方式：
   • a) 使用开发容器

     ⚠️ Windows 用户重要提示：请将此仓库克隆到 WSL 卷上，或者使用“在命名容器卷中克隆仓库”命令。否则可能会遇到性能问题。

     • 在您选择的 IDE 中打开项目目录：
       • VS Code 应会提示您“在容器中打开”。
         • 如果没有提示，您可以手动运行“Dev Containers: 在容器中打开文件夹”。
       • 对于其他 IDE，您可能需要打开 .devcontainer/devcontainer.json 文件，然后点击“创建开发容器并挂载源代码”。
       • 注意：首次运行可能需要一些时间。
     • 运行 make run 或 npm run dev。
   • b) 运行 make init
     • 此命令会执行以下操作：
       • 创建一个基础的 .env 文件。
       • 安装 npm 包。
       • 启动 Docker 容器。
       • 执行任何额外的数据库迁移。
       • 创建一些示例种子数据。
       • 初始化指标和 MeiliSearch。
       • 初始化 Prisma。
       • 启动服务器。
     • 如果您看到找不到应用程序的错误，请确保将 node_modules/.bin 添加到您的 PATH 中：
       • export PATH="$PATH:$(realpath node_modules/.bin)"
     • 如果您是内部成员，可以使用 Buzz 和信号服务：
       • 首次设置时，在 GitHub 上创建一个具有读取包权限的个人访问令牌。
       • 将其设置为环境变量 CR_PAT。
       • 运行 echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin。
   • 如有任何关于这些命令的问题，请在 Discord 上向我们反馈。
4. 编辑 .env.development 文件。
   • 大多数默认值已经配置好可以直接使用，但 S3 上传密钥和密钥除外。要生成这些密钥，请访问 Minio 的 Web 界面：http://localhost:9000，使用默认用户名和密码 minioadmin 登录，然后进入“访问密钥”选项卡。点击“创建访问密钥”，并将生成的密钥和密钥复制到 .env 文件中（S3_UPLOAD_KEY 和 S3_UPLOAD_SECRET, S3_IMAGE_UPLOAD_KEY 和 S3_IMAGE_UPLOAD_SECRET）。
   • 将 WEBHOOK_TOKEN 设置为任意随机字符串。此令牌将用于验证 webhook 端点的请求。
   • 在电子邮件相关字段中添加任意随机字符串，以启用用户注册功能：
     • EMAIL_USER
     • EMAIL_PASS
     • EMAIL_FROM（需符合有效的电子邮件格式）。
5. 运行 git submodule update --recursive。
6. 最后，访问 http://localhost:3000 查看网站。

* 注意：账户创建过程中会通过 maildev 发送邮件，您可以在 http://localhost:1080 查看这些邮件。

修改用户权限

• 首先，通过界面正常创建一个账户。
• 如果您希望将自己设置为版主，请执行以下操作：
  • 使用数据库编辑工具（如 DataGrip）或直接连接到数据库（PGPASSWORD=postgres psql -h localhost -p 15432 -U postgres civitai）。
  • 找到您的用户记录（通过邮箱或用户名），并将 isModerator 字段设置为 true。

已知限制

目前，需要外部输入的服务在本地环境中无法正常运行，包括：

• 编排（生成、训练）
• 信号（聊天、通知等实时更新）
• Buzz

贡献

您所做的任何贡献都非常感谢。

如果您有改进建议，请 fork 该仓库并创建一个 pull request。您也可以直接提交一个带有“enhancement”标签的问题。别忘了给项目点个 star！再次感谢！

1. 将仓库 fork 到您自己的 GitHub 账号。
2. 为您的更改创建一个新的分支。
3. 对代码进行修改。
4. 提交更改并将分支推送到您的 fork 仓库。
5. 在我们的仓库中打开一个 pull request。

如果您希望更深入地参与，可以考虑加入社区开发团队！有关团队的更多信息以及如何加入，请参阅 号召所有开发者：加入 Civitai 社区开发团队。

数据迁移

在开发过程中，您可能需要更改数据库结构。为此：

1. 修改 schema.prisma 文件。
2. 在 prisma/migrations 文件夹中创建一个以 YYYYMMDDHHmmss_简要描述_here 为命名规范的文件夹。
3. 在该文件夹中创建一个名为 migration.sql 的文件。
4. 在该文件中编写您的 SQL 更改语句。
   • 这些通常是简单的 SQL 命令，例如 ALTER TABLE ...。
5. 运行 make run-migrations 和 make gen-prisma。
6. 如果您正在添加或更改列或表，请尽量保持 gen_seed.ts 文件与这些更改同步。

赞助商

通过成为赞助商来支持本项目。您的 logo 将在此处显示，并附带指向您网站的链接。

许可证

Apache License 2.0 - 请查看 LICENSE 以获取更多详细信息。

Civitai 开源平台快速上手指南

Civitai 是一个用于分享和协作开发 Stable Diffusion 模型（如 Textual Inversions、Hypernetworks、VAEs 等）的开源平台。本项目基于 Next.js、tRPC、Prisma 和 Postgres 构建。

环境准备

在开始之前，请确保您的机器已安装以下依赖：

• Docker: 用于运行数据库和本地服务。
  • 下载地址：https://www.docker.com/
• Node.js: 版本需为 20 或更高。
  • 推荐使用 nvm 管理 Node 版本：

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
    

• Make (可选): 用于简化初始设置命令。
• IDE (可选): 若使用开发容器，推荐 VS Code (需安装 Dev Containers 插件) 或 JetBrains 系列 IDE。

Windows 用户注意: 若使用 Dev Containers，请将代码克隆到 WSL 卷中，或使用"clone repository in named container volume"命令，否则会遇到性能问题。

安装步骤

1. 克隆项目

将仓库克隆到本地机器：

git clone <repository-url>
cd civitai

2. 初始化环境

您可以选择以下两种方式之一进行启动：

方式 A：使用 Make 命令（推荐） 运行初始化命令，它将自动创建环境变量文件、安装依赖、启动 Docker 容器、执行数据库迁移并生成种子数据：

make init

注：若遇到 "app not found" 错误，请执行 export PATH="$PATH:$(realpath node_modules/.bin)"。

方式 B：使用 Dev Containers

• VS Code: 打开文件夹，当提示 "Open in container" 时确认，或手动运行 Dev Containers: Open Folder in Container。
• 其他 IDE: 打开 .devcontainer/devcontainer.json 并点击 "Create devcontainer and mount sources"。
• 容器启动后，运行：

  make run
  # 或
  npm run dev
  

3. 配置环境变量

编辑 .env.development 文件：

1. 配置 S3 存储密钥:
   • 访问 http://localhost:9000 (MinIO 界面)。
   • 登录账号/密码均为 minioadmin。
   • 进入 "Access Keys" 标签页，点击 "Create Access Key"。
   • 将生成的 Key 和 Secret 填入 .env.development 中的 S3_UPLOAD_KEY, S3_UPLOAD_SECRET, S3_IMAGE_UPLOAD_KEY, S3_IMAGE_UPLOAD_SECRET。
2. 配置 Webhook:
   • 设置 WEBHOOK_TOKEN 为任意随机字符串。
3. 配置邮件服务 (用于注册):
   • 为 EMAIL_USER, EMAIL_PASS, EMAIL_FROM (需合法邮箱格式) 填入任意随机字符串以启用本地注册功能。

4. 更新子模块

git submodule update --recursive

5. 启动验证

访问 http://localhost:3000 查看网站。

• 邮件预览: 注册邮件将通过 Maildev 发送，可在 http://localhost:1080 查看。

基本使用

1. 创建管理员账户

1. 在前端页面正常注册一个用户账号。
2. 通过数据库工具将该用户提升为管理员（Moderator）：
   • 方法一 (命令行):

     PGPASSWORD=postgres psql -h localhost -p 15432 -U postgres civitai
     

     在 SQL 提示符下执行（替换为您的用户名或邮箱）：

     UPDATE "User" SET "isModerator" = true WHERE username = '您的用户名';
     -- 或者
     UPDATE "User" SET "isModerator" = true WHERE email = '您的邮箱';
     

   • 方法二 (GUI 工具): 使用 DataGrip 等工具连接数据库 (localhost:15432, 用户 postgres, 密码 postgres, 库 civitai)，找到用户表并将 isModerator 字段改为 true。

2. 已知限制

本地开发环境下，以下依赖外部输入的服务暂时不可用：

• 编排服务（生成、训练）
• 信号服务（聊天、通知、实时更新）
• Buzz 积分系统

现在您可以开始在本地浏览模型、上传资源并进行开发了。