Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .vitepress/data/dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,7 @@ dependencies:
home: https://github.com/kloudkit/ws-cli
license: MIT
package: github.com/kloudkit/ws-cli
version: 0.0.36
version: 0.0.43

yamllint:
cmd: yamllint --version
Expand Down
52 changes: 52 additions & 0 deletions .vitepress/data/env.reference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,58 @@ envs:
description: Combined log file for `stdout` and `stderr`.
since: 0.0.21

secrets:
properties:
master_key:
type: string
default: null
example: dGhpcyBpcyBhIHNlY3JldCBrZXkgZXhhbXBsZQ==
since: 0.1.1
description: Master encryption key for secrets vault.
longDescription: |
Used to encrypt and decrypt secrets in the vault.
Can be provided as:

- A base64-encoded string.
- A plaintext string.

**Master key lookup precedence:**

1. CLI `--master` flag *(if provided)*.
2. `WS_SECRETS_MASTER_KEY` *(this variable)*.
3. `WS_SECRETS_MASTER_KEY_FILE`.
4. `/etc/workspace/master.key` *(default path)*.

master_key_file:
type: string
default: /etc/workspace/master.key
example: /etc/workspace/custom-master.key
since: 0.1.1
description: Path to file containing the master encryption key.
longDescription: |
Used to encrypt and decrypt secrets in the vault.
Can be provided as:

- A base64-encoded string.
- A plaintext string.

**Master key lookup precedence:*

1. CLI `--master` flag *(if provided)*.
2. `WS_SECRETS_MASTER_KEY`.
3. `WS_SECRETS_MASTER_KEY_FILE` *(this variable)*.
4. `/etc/workspace/master.key` *(default path)*.

vault:
type: string
default: null
example: /workspace/.vault.yaml
since: 0.1.1
description: Path to the secrets vault file.
longDescription: |
A YAML file containing encrypted secrets that can be decrypted and
deployed to various destinations during startup.

server:
properties:
port:
Expand Down