Skip to content

Commit 4f53771

Browse files
rickstaaclaude
andcommitted
docs: describe what the base compose file actually does
It does not always build from source: with no `image:` key it builds once, then reuses that local image until --build. What is load-bearing is that it never reaches a registry, which is what makes the overlay the only path to the published image. Also drops the note about the frozen `rickstaa/` images. Those were never production, and it was the only thing in the repo pointing readers at a personal namespace. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent e96a9b4 commit 4f53771

5 files changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,6 @@ docker compose -f compose.yml -f compose.image.yml up -d
138138

139139
The base `compose.yml` always builds from source, so the registry is reached only when you ask for it by adding the overlay. It stacks with the on-chain one (`-f compose.yml -f compose.onchain.yml -f compose.image.yml`).
140140

141-
> [!NOTE]
142-
> The images previously published under `rickstaa/` on Docker Hub are frozen; use the GHCR ones.
143-
144141
### On-chain (paid) setup
145142

146143
On-chain runs add a **remote signer** that holds the payer wallet and mints [probabilistic micropayment](https://medium.com/livepeer-blog/a-primer-on-livepeers-probabilistic-micropayments-e16788b29331) tickets; the orchestrator redeems the winning ones. Shared across examples:

echo/compose.image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Run the published image instead of building. Layer it on the offchain base:
22
# docker compose -f compose.yml -f compose.image.yml up -d
33
#
4-
# The base file always builds from source, so this overlay is the only way to
5-
# reach the registry; `pull_policy: always` keeps a stale local copy from
6-
# shadowing the published one. Stacks with the on-chain overlay too:
4+
# The base file names no image, so it never reaches a registry: it builds, then
5+
# reuses that local build until you pass --build. This overlay is the only path
6+
# to the published image, and `pull_policy: always` is what stops a stale local
7+
# copy of the moving `latest` tag from shadowing it. Stacks with on-chain too:
78
# docker compose -f compose.yml -f compose.onchain.yml -f compose.image.yml up -d
89

910
services:

hello-world/compose.image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Run the published image instead of building. Layer it on the offchain base:
22
# docker compose -f compose.yml -f compose.image.yml up -d
33
#
4-
# The base file always builds from source, so this overlay is the only way to
5-
# reach the registry; `pull_policy: always` keeps a stale local copy from
6-
# shadowing the published one. Stacks with the on-chain overlay too:
4+
# The base file names no image, so it never reaches a registry: it builds, then
5+
# reuses that local build until you pass --build. This overlay is the only path
6+
# to the published image, and `pull_policy: always` is what stops a stale local
7+
# copy of the moving `latest` tag from shadowing it. Stacks with on-chain too:
78
# docker compose -f compose.yml -f compose.onchain.yml -f compose.image.yml up -d
89

910
services:

realtime-transcription/compose.image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Run the published image instead of building. Layer it on the offchain base:
22
# docker compose -f compose.yml -f compose.image.yml up -d
33
#
4-
# The base file always builds from source, so this overlay is the only way to
5-
# reach the registry; `pull_policy: always` keeps a stale local copy from
6-
# shadowing the published one. Stacks with the on-chain overlay too:
4+
# The base file names no image, so it never reaches a registry: it builds, then
5+
# reuses that local build until you pass --build. This overlay is the only path
6+
# to the published image, and `pull_policy: always` is what stops a stale local
7+
# copy of the moving `latest` tag from shadowing it. Stacks with on-chain too:
78
# docker compose -f compose.yml -f compose.onchain.yml -f compose.image.yml up -d
89

910
services:

tiles/compose.image.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Run the published image instead of building. Layer it on the offchain base:
22
# docker compose -f compose.yml -f compose.image.yml up -d
33
#
4-
# The base file always builds from source, so this overlay is the only way to
5-
# reach the registry; `pull_policy: always` keeps a stale local copy from
6-
# shadowing the published one. Stacks with the on-chain overlay too:
4+
# The base file names no image, so it never reaches a registry: it builds, then
5+
# reuses that local build until you pass --build. This overlay is the only path
6+
# to the published image, and `pull_policy: always` is what stops a stale local
7+
# copy of the moving `latest` tag from shadowing it. Stacks with on-chain too:
78
# docker compose -f compose.yml -f compose.onchain.yml -f compose.image.yml up -d
89

910
services:

0 commit comments

Comments
 (0)