Skip to content

Commit

Permalink
docs: add configure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andydunstall committed May 1, 2024
1 parent 7b83ae9 commit 5a7015e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,9 @@ curl --connect-to my-endpoint.example.com:8000:localhost:8000 http://my-endpoint
## Docs

See [docs](./docs) for details on deploying and managing Pico:
- [Kubernetes](./docs/deploy/kubernetes.md)
- [Observability](./docs/deploy/observability.md)
- [Configure](./docs/deploy/configure.md)
- [Kubernetes](./docs/deploy/kubernetes.md)
- [Observability](./docs/deploy/observability.md)

## Limitations

Expand Down
14 changes: 14 additions & 0 deletions docs/deploy/configure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Configure

Pico server and agent support both YAML configuration and command-line flags.

The YAML file path can be set using `--config.path`.

## Variable Substitution

When enabling `--config.expand-env`, Pico will expand environment variables
in the loaded YAML configuration. This will replace references to `${VAR}`
and `$VAR` with the corresponding environment variable.

If the environment variable is not defined, it will be replaced with an empty
string. You can also defined a default value using form `${VAR:default}`.

0 comments on commit 5a7015e

Please sign in to comment.