diff --git a/.changeset/free-dogs-marry.md b/.changeset/free-dogs-marry.md new file mode 100644 index 0000000..88858ca --- /dev/null +++ b/.changeset/free-dogs-marry.md @@ -0,0 +1,5 @@ +--- +'@cloudflare/containers': minor +--- + +add pingEndpoint to configure the ping URL of the container class diff --git a/README.md b/README.md index b7e19f7..c44a78d 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,17 @@ The following properties are used to set defaults when starting the container, b Defaults to `true`. +- `pingEndpoint: string` + + Specify an endpoint the container class will hit to check if the underlying instance started. + This does not need to be set by the majority of people, only use it if you would like the container supervisor + to hit another endpoint in your container when it starts it. + Observe that `pingEndpoint` can include both the hostname and the path. You can + set `container/health`, meaning `"container"` will be the value passed along the `Host` header, and + `"/health"` the path. + + Defaults to `ping`. + #### Methods ##### Lifecycle Hooks