Skip to content

Commit b8a9cc5

Browse files
committed
Updated docker support docs to match master
1 parent ab6be75 commit b8a9cc5

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/reference/docker-support.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,10 @@ You can also use the builder stage as the base for the running stage (and inheri
193193
:::
194194

195195
### Option `rti-image`
196-
To run a federated program, an RTI process must run to support it. By default, an image for the RTI is pulled from DockerHub. An alternative image can be specified using the `rti-image` entry.
196+
To run a federated program, an RTI process must run to support it. By default, the RTI is built locally in a Docker image. This is equivalent to specifying `rti-image: "rti:local"`.
197197

198-
The default is `"lflang/rti:latest"`, which is available on DockerHub. To instruct the compiler to _not_ pull an image from DockerHub and build the RTI locally, use `rti-image: "rti:local"`.
198+
An alternative image to be pulled from DockerHub can be specified using the `rti-image` entry.
199+
For example, you can specify `"lflang/rti:latest"`, an image that is available on DockerHub.
199200

200201
:::note
201202
The value of the `builder-base`, `runner-base`, and `rti-image` entry should follow Docker's `<user-name>/<image-name>:<tag-name>` naming convention for image names. Docker will resolve the name and pull the image from your local registry, or, if it cannot be found, from DockerHub.

0 commit comments

Comments
 (0)