Skip to content

Commit

Permalink
Fix param order
Browse files Browse the repository at this point in the history
  • Loading branch information
akclace committed Jun 3, 2024
1 parent 6ad4d1c commit d9aa359
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion content/docs/App/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ This is defining three parameters. The type can be one of `STRING`(default), `IN

The parameters are available in the app Starlark code, through the `param` namespace. For example, `param.port`, `param.app_name` etc. See https://github.com/claceio/appspecs/blob/main/python-flask/app.star for an example of how this can be used.

Params are set, during app creation using `app create --param port=9000` or using `param update /myapp port 9000`. Set value to `-` to delete the param. Use `param list /myapp` to list the params.
Params are set, during app creation using `app create --param port=9000` or using `param update port 9000 /myapp`. Set value to `-` to delete the param. Use `param list /myapp` to list the params.

For containerized apps, all params specified for the app (including ones not specified in `params.star` spec) are passed to the container at runtime as environment parameters. `CL_APP_PATH` is a special param passed to the container with the app installation path (without the domain name).

Expand Down
2 changes: 1 addition & 1 deletion content/docs/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ does the following:

When the first API call is done to the app (lazy-loading), the Clace server will build the container image from the `Containerfile` defined in the spec, start the container and setup the proxy for the app APIs.

Any env params which need to be passed to the app can be configured as [app params]({{< ref "app/overview/#app-parameters" >}}). Params are set, during app creation using `app create --param port=9000` or after creation using `param update /myapp port 9000`.
Any env params which need to be passed to the app can be configured as [app params]({{< ref "app/overview/#app-parameters" >}}). Params are set, during app creation using `app create --param port=9000` or after creation using `param update port 9000 /myapp`.

If the source repo has a `Containerfile` or `Dockerfile`, the `container` spec is a generic spec which works with any language or framework. If the container file defined a port using `EXPOSE` directive, then port is not required. Otherwise, specify a port, for example

Expand Down

0 comments on commit d9aa359

Please sign in to comment.