docs(readme): update docker section (#10716)
Marcin Rataj committed
Feb 18, 2025 at 21:59 UTC
f00e115e1ed094d47b3abe30d86fea40c6ca2f60
1 file changed
+14
-9
README.md
+14
-9
@@ -125,18 +125,23 @@ The canonical download instructions for IPFS are over at: https://docs.ipfs.tech
125
126
### Docker
127
128
-Official images are published at https://hub.docker.com/r/ipfs/kubo/:
128
+Official images are published at https://hub.docker.com/r/ipfs/kubo/: [](https://hub.docker.com/r/ipfs/kubo/)
129
130
-[](https://hub.docker.com/r/ipfs/kubo/)
130
+#### 🟢 Release Images
131
+ - These are production grade images. Use them.
132
+ - `latest` and [`release`](https://hub.docker.com/r/ipfs/kubo/tags?name=release) tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest). If you use this, remember to `docker pull` periodically to update.
133
+ - [`vN.N.N`](https://hub.docker.com/r/ipfs/kubo/tags?name=v) points at a specific [release tag](https://github.com/ipfs/kubo/releases)
134
132
-- 🟢 Releases
133
- - `latest` and `release` tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest)
134
- - `vN.N.N` points at a specific [release tag](https://github.com/ipfs/kubo/releases)
135
- - These are production grade images.
136
-- 🟠 We also provide experimental developer builds
137
- - `master-latest` always points at the `HEAD` of the `master` branch
138
- - `master-YYYY-DD-MM-GITSHA` points at a specific commit from the `master` branch
135
+#### 🟠 Developer Preview Images
136
- These tags are used by developers for internal testing, not intended for end users or production use.
137
+ - [`master-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-latest) always points at the `HEAD` of the [`master`](https://github.com/ipfs/kubo/commits/master/) branch
138
+ - [`master-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-2) points at a specific commit from the `master` branch
139
+
140
+#### 🔴 Internal Staging Images
141
+ - We use `staging` for testing arbitrary commits and experimental patches.
142
+ - To build image for current HEAD, force push to `staging` via `git push origin HEAD:staging --force`)
143
+ - [`staging-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-latest) always points at the `HEAD` of the [`staging`](https://github.com/ipfs/kubo/commits/staging/) branch
144
+ - [`staging-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-2) points at a specific commit from the `staging` branch
145
146
```console
147
$ docker pull ipfs/kubo:latest