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

GUACAMOLE-1976: Add documentation for the OPTIONAL token modifier. #264

Merged
merged 1 commit into from
Oct 21, 2024
+15 −0
Merged

GUACAMOLE-1976: Add documentation for the OPTIONAL token modifier. #264

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
15 changes: 15 additions & 0 deletions src/configuring-guacamole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2755,6 +2755,21 @@ supported:
`UPPER`
: Convert the entire value of the token to upper-case.

`OPTIONAL`
: Typically when tokens are specified as part of a connection parameter,
if the token is undefined, the literal value of the token will be placed
in the connection parameter. This modifier marks a token as "optional",
which means that an undefined token will not be added as a literal and
will simply be skipped as if the token is not entered.

In some cases this will simply result in a string lacking the information
that would otherwise be in the token; however, in other cases this may
result in Guacamole generating prompts. For example, if you specify the
token `${GUAC_PASSWORD:OPTIONAL}` for the password field in a connection,
but you sign in with an SSO extension such that the user does not have a
`${GUAC_PASSWORD}` token, Guacamole may prompt you for the password as
if it had not been provided at all.

(extension-tokens)=

#### Extension-specific tokens
Expand Down
Loading