Skip to content

Commit fc1f3fc

Browse files
committed
文档:明确本项目不提供 Docker 镜像与预编译二进制
1 parent 598623f commit fc1f3fc

2 files changed

Lines changed: 64 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,37 @@ PixelAPI 把 AI 订阅账号(Claude、Codex/OpenAI、Gemini、Antigravity、Gr
9595

9696
## 部署
9797

98-
> **注意**:`deploy/install.sh` 与 `deploy/docker-compose*.yml` 中的下载地址和镜像
99-
> (`Wei-Shaw/sub2api` releases、`weishaw/sub2api` 镜像)指向的是**上游发布物**,
100-
> 用它们装到的是上游 Sub2API,不是本分支。本分支目前请从源码构建。
98+
### ⚠️ 本项目不提供 Docker 镜像和预编译二进制
99+
100+
**这一点请务必先看清楚,否则你装到的会是另一个项目。**
101+
102+
本仓库**没有**发布任何 Docker 镜像,Docker Hub 上不存在 PixelAPI 的镜像;本仓库的 Releases
103+
也只提供源码,**不附带预编译二进制**。
104+
105+
而 `deploy/` 目录下的部署文件是从上游继承下来的,里面写死的地址**全部指向上游 Sub2API**:
106+
107+
| 文件 | 里面写的东西 | 实际会装到什么 |
108+
| --- | --- | --- |
109+
| `deploy/docker-compose.yml`<br>`deploy/docker-compose.local.yml` | `image: weishaw/sub2api:latest` | **上游 Sub2API 的官方镜像**,不是本项目 |
110+
| `deploy/install.sh` | `GITHUB_REPO="Wei-Shaw/sub2api"` | 从**上游 Releases** 下载的二进制,不是本项目 |
111+
112+
也就是说,直接 `docker compose up -d` 或者跑那条一键安装脚本,起来的是上游 Sub2API,
113+
本分支的账号广场、共享结算、Grok 接入等功能一个都不会有。
114+
115+
**唯一受支持的方式是[从源码构建](#从源码构建)。**
116+
117+
如果你确实需要容器化部署,得自己构建镜像——仓库根目录的 `Dockerfile` 是完整的多阶段构建
118+
(前端 + 内嵌前端的 Go 二进制),可以直接用:
119+
120+
```bash
121+
# 自行构建镜像
122+
docker build -t pixelapi:local .
123+
124+
# 然后把 compose 文件里的 image 换成自己构建的 tag
125+
# image: weishaw/sub2api:latest -> image: pixelapi:local
126+
```
127+
128+
同理,`deploy/install.sh` 若要复用,需要自行把 `GITHUB_REPO` 和产物下载逻辑改成你自己的发布源。
101129

102130
### 从源码构建
103131

‎README_EN.md‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,39 @@ by room or group, and the platform handles routing, metering, revenue split and
9999

100100
## Deployment
101101

102-
> **Note**: `deploy/install.sh` and `deploy/docker-compose*.yml` still point at **upstream artifacts**
103-
> (`Wei-Shaw/sub2api` releases, the `weishaw/sub2api` image). Using them installs upstream Sub2API, not
104-
> this fork. Build from source for now.
102+
### ⚠️ No Docker Image or Prebuilt Binary Is Published
103+
104+
**Read this first, or you will end up installing a different project.**
105+
106+
This repository publishes **no Docker image** — there is no PixelAPI image on Docker Hub — and its
107+
Releases contain **source code only, with no prebuilt binaries attached**.
108+
109+
The files under `deploy/` are inherited from upstream, and every address hardcoded in them points at
110+
**upstream Sub2API**:
111+
112+
| File | What it references | What you actually get |
113+
| --- | --- | --- |
114+
| `deploy/docker-compose.yml`<br>`deploy/docker-compose.local.yml` | `image: weishaw/sub2api:latest` | **Upstream Sub2API's official image**, not this project |
115+
| `deploy/install.sh` | `GITHUB_REPO="Wei-Shaw/sub2api"` | A binary from **upstream Releases**, not this project |
116+
117+
In other words, running `docker compose up -d` or that one-liner install script gives you upstream
118+
Sub2API — with none of this fork's account marketplace, shared-revenue settlement or Grok support.
119+
120+
**Building [from source](#build-from-source) is the only supported path.**
121+
122+
If you do need containerized deployment, build the image yourself. The `Dockerfile` at the repository
123+
root is a complete multi-stage build (frontend plus a Go binary with the frontend embedded):
124+
125+
```bash
126+
# Build your own image
127+
docker build -t pixelapi:local .
128+
129+
# Then replace the image in the compose files with your own tag
130+
# image: weishaw/sub2api:latest -> image: pixelapi:local
131+
```
132+
133+
Likewise, to reuse `deploy/install.sh` you must repoint `GITHUB_REPO` and its download logic at your
134+
own release source.
105135

106136
### Build From Source
107137

0 commit comments

Comments
 (0)