You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README_EN.md
+33-3Lines changed: 33 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,9 +99,39 @@ by room or group, and the platform handles routing, metering, revenue split and
99
99
100
100
## Deployment
101
101
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
0 commit comments