Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update app-configuration.mdx: add env var info #77

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Update app-configuration.mdx: add env var info #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion pages/edge/configuration/app-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ kind: wasmer.io/App.v0
name: my-sample-site
description: A sample site for demonstration (optional)
package: wasmer/my-sample-site

# Specify environment variables
env:
MY_VAR: "my-value123"
```

## Fields
Expand Down Expand Up @@ -41,10 +45,26 @@ The `description` field is used to provide a description of the application. It

### `package`

The `package` field is used to provide the primary workload to execute. It is **required** and must be a valid WebAssembly package identifier.
The `package` field is used to specify the name of the package to deploy.
It is **required** and must specify a package published to the Wasmer registry.

Note: if you have a wasmer.toml in the same directory as the `app.yaml`, `wasmer deploy` will automatically prompt you to publish a new version of the package.

- Required: `true`

### `env`

Specify environment variables for the app.
Must be a key-value map.

Example:
```yaml
env:
MY_VAR: "my-value123"
```

- Required: `false`

### `debug`

The `debug` field is used to enable debug mode for the application. This in turn will show detailed error messages if a request fails, instead of a generic error. It is **optional** and can be any boolean.
Expand All @@ -62,4 +82,6 @@ kind: wasmer.io/App.v0
name: wasmer-python-flask-server-myapp-example
package: wasmer/python-flask-server-myapp-example@0.1.0
debug: false
env:
MY_VAR: "my-value123"
```
Loading