From 34ade7e58cfdb5e7c54fcfdce42fa01984a364e1 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Fri, 29 Aug 2025 17:01:18 +0200 Subject: [PATCH] docs: moar secret generation modifiers See https://git.coopcloud.tech/toolshed/abra/pulls/607 --- docs/maintainers/handbook.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/maintainers/handbook.md b/docs/maintainers/handbook.md index 1eec361..0113459 100644 --- a/docs/maintainers/handbook.md +++ b/docs/maintainers/handbook.md @@ -489,6 +489,35 @@ If you want to get the highest rating on SSL certs, you can use the following tr See [this PR](https://git.coopcloud.tech/coop-cloud/traefik/pulls/8/files) for the technical details +## How do I skip secret generation for a specific secret + +!!! warning "Watch out for old versions of `abra` 🚧" + + This feature is only available in the >= 0.11.x series of `abra`. + +Add the `# generate=false` comment + +``` +SECRET_JWT_SECRET_VERSION=v1 # generate=false +``` + +## How do I specify the charset for a specific secret generation + +!!! warning "Watch out for old versions of `abra` 🚧" + + This feature is only available in the >= 0.10.x series of `abra`. + +``` +SECRET_JWT_SECRET_VERSION=v1 # charset=default,special +``` + +Options are: +* `default`: [source](https://github.com/decentral1se/passgen/blob/8404cb922dea92efa8c3514f0ec8c37ce12a880f/const.go#L23) +* `special`: [source](https://github.com/decentral1se/passgen/blob/8404cb922dea92efa8c3514f0ec8c37ce12a880f/const.go#L22C29-L22C43) +* `safespecial`: [source](https://git.coopcloud.tech/toolshed/abra/src/commit/6abaf7a094df1a96599af2c4cbae1769821ad17c/pkg/secret/secret.go#L182) +* `default,special`: mix of `default` and `special` +* `default,safespecial`: mix of `default` and `safespecial` + ## How do I change secret generation length? It is possible to tell `abra` which length it should generate secrets with from your recipe config.