# ImgYoung

- [介绍](/zh/docs): ImgYoung 是一个多渠道主备容灾的自部署图床，图片同时存进多个存储渠道，任何一个出问题都不影响上传和访问。
- [快速开始](/zh/docs/quick-start): 用 Docker 跑起 ImgYoung，登录后台，上传第一张图并拿到 Markdown 链接。

- **安装**
- 安装
  - [安装方式](/zh/docs/install): 五种安装方式的对比：一行脚本、Docker 镜像、Docker Compose、发布包与源码构建。
  - [一行安装脚本](/zh/docs/install/script): 在 Linux 与 macOS 上下载发布版、校验 sha256 并装入 PATH；Linux 上可同时注册 systemd 服务。重复执行即升级。
  - [Docker 镜像](/zh/docs/install/docker): 用 GHCR 上的多架构镜像运行 ImgYoung：启动命令、镜像标签、数据卷、环境变量与反向代理下的设置。
  - [Docker Compose](/zh/docs/install/compose): 用仓库里的 compose.yaml 运行 ImgYoung，以及与 Caddy 组合、自动申请证书对外提供 HTTPS 的写法。
  - [发布包](/zh/docs/install/binary): 下载对应平台的发布包，校验 sha256 后直接运行；适合 Windows 与不便执行安装脚本的环境。
  - [源码构建](/zh/docs/install/source): 从源码构建带管理后台的单二进制，以及构建参数背后的原因。

- **使用**
- 使用指南
  - [上传](/zh/docs/guides/upload): 用 HTTP 接口、URL 转存或管理后台上传图片，以及格式与大小限制、EXIF 处理、幂等键、查重关系与写入语义。
  - [上传客户端](/zh/docs/guides/clients): 把 PicGo、PicList、Typora、aws CLI、rclone 等客户端接到 ImgYoung：自定义 Web 图床与 S3 协议两种方式。
  - [访问图片](/zh/docs/guides/access): 图片链接的两种形式、缓存与条件请求、按需缩放与 WebP 协商、代理与 302 两种访问模式、防盗链，以及访问计数的口径。
  - [生命周期与查重](/zh/docs/guides/lifecycle): 有效期的三层取值与访问续期、到期清理与三段式删除、冷图待清理的打标与裁决，以及精确重复自动合并与相似重复人工裁决。
  - [管理后台](/zh/docs/guides/admin): 管理后台各页面的用途、管理员与普通用户的权限差别、配额与上传频控、上传 Token 的完整生命周期，以及登录、会话与界面偏好。

- **存储渠道**
- 存储渠道
  - [渠道与容灾](/zh/docs/channels): 渠道是什么、上传写到哪里、副本如何补齐、访问如何切换，以及健康探测、编辑、删除与用量告警的规则。
  - [对象存储与 WebDAV](/zh/docs/channels/object-storage): 内置对象存储模板逐个要填什么、为什么要预先建桶、公开访问地址与 302 直链、自定义模式与通用 WebDAV，以及探测失败时的报错与排查。
  - [网盘与 OAuth](/zh/docs/channels/cloud-drives): 需要授权的网盘有哪些、两条授权路径怎么走、令牌如何续期与落库，国内网盘如何经自部署的聚合服务以 WebDAV 接入，以及网盘渠道的固有限制。
  - [渠道存储加密](/zh/docs/channels/encryption): 用 rclone crypt 让存储商只看到密文：防什么、怎么开、为什么建后不可变、密钥从哪里来，以及不依赖 ImgYoung 用标准 rclone 解密渠道数据。

- **配置与运维**
- [配置](/zh/docs/configuration): 引导配置（环境变量）与运营配置（后台设置）的全部配置项、默认值、取值范围与生效方式，以及主密钥的保管。
- 运维
  - [反向代理与 HTTPS](/zh/docs/operations/reverse-proxy): 用 Caddy 或 Nginx 前置 ImgYoung，正确配置 IMGYOUNG_TRUSTED_PROXIES、base_url 与上传体积上限。
  - [CDN](/zh/docs/operations/cdn): 在 ImgYoung 前面加 CDN：缓存头、WebP 协商与 Vary、按需处理的缓存键、Cloudflare 缓存清除，以及 302 模式和防盗链在 CDN 后的表现。
  - [备份与恢复](/zh/docs/operations/backup): 元数据库自动快照、从快照恢复、主机全损后的灾难恢复、元数据导出与对账 GC。
  - [升级](/zh/docs/operations/upgrade): 各安装方式的升级命令、启动时自动执行的数据库迁移，以及回滚时的注意事项。
  - [忘记密码](/zh/docs/operations/password-reset): 内置管理员忘记密码时，清空密码哈希并重启以恢复出厂密码；管理员为其他用户重置密码。
  - [监控与告警](/zh/docs/operations/monitoring): /healthz 与 /metrics、Prometheus 抓取、告警条件与 Webhook 负载格式、日志。

- **开发者**
- Go 库
  - [作为 Go 库使用](/zh/docs/library): ImgYoung 的存储层是三个可 go get 的公开包：驱动接口、rclone 实现与多存储容灾原语。
  - [驱动接口与 rclone 实现](/zh/docs/library/driver): Driver 接口的契约、rclone.Open 的参数、密码类参数编码、OAuth 令牌写回、crypt 加密层，以及如何自带驱动。
  - [多存储容灾](/zh/docs/library/failover): store/failover 的写入、读取与健康探测原语，完整的主备示例，以及如何在原语之上自己做副本补齐。
- 接口参考
  - [接口参考](/zh/docs/api): ImgYoung HTTP 接口的认证方式、错误格式与通用约定；各分组的接口详情由 OpenAPI 文档生成。
  - [数据面](/zh/docs/api/data-plane): 上传 Token 认证的上传与 URL 转存
  - [图片访问](/zh/docs/api/image-access): 公开的图片输出入口，受防盗链约束
  - [系统](/zh/docs/api/system): 健康检查与接口文档
  - [后台·会话](/zh/docs/api/admin-session): 登录、登出、当前用户与改密
  - [后台·总览与配置](/zh/docs/api/admin-overview): 仪表盘与运行配置
  - [后台·上传](/zh/docs/api/admin-upload): 会话认证的后台上传，与数据面同一管道
  - [后台·图片](/zh/docs/api/admin-images): 图片列表、详情、修改与删除
  - [后台·上传 Token](/zh/docs/api/admin-tokens): 具名 Token 的签发、轮转、吊销与 S3 凭证
  - [后台·存储渠道](/zh/docs/api/admin-channels): 渠道模板、创建、编辑、探测、删除与网盘授权
  - [后台·用户](/zh/docs/api/admin-users): 多用户建号、配额与密码重置（仅管理员）
  - [后台·防盗链](/zh/docs/api/admin-referer): Referer 白名单（仅管理员）
  - [后台·裁决](/zh/docs/api/admin-review): 相似重复与冷图待清理的裁决（仅管理员）
  - [后台·运维](/zh/docs/api/admin-operations): 审计日志、告警、备份快照与元数据导出（仅管理员）
- [架构](/zh/docs/architecture): 单实例设计、分层与依赖方向、数据模型、上传与访问的数据流、outbox 围栏、周期任务，以及为什么在进程内集成 rclone。

## Full text and other languages

- [中文全文 (Chinese full text)](/zh/llms-full.txt)
- [English index](/en/llms.txt)
- [English full text](/en/llms-full.txt)