Skip to content

Update secrets explanation page #123

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update secrets explanation page #123

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
9 changes: 4 additions & 5 deletions src/content/docs/explanations/secrets/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,11 @@ into the string `"***"`.

In general, Tenzir does not assume that a secret is valid UTF-8, although most
operators will make that constraint. Conversely some secret stores may require
your secrets to be UTF-8, while some operators expect a binary secret.
your secrets to be UTF-8, while some operators expect a binary or otherwise
encoded secret.

To bridge this gap, you can base64-decode secrets using the
[`decode_base64`](/reference/functions/decode_base64) function and
base64-encode them using the [`encode_base64`](/reference/functions/encode_base64)
function:
To bridge this gap, you can use Tenzir's [encoding](/reference/functions#encoding)
and [decoding](/reference/functions#decoding) functions:

```tql
let $binary_secret = secret("my-encoded-secret").decode_base64()
Expand Down