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.

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

RHIDP-5491 configure expiry on refresh token cookie #899

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

Conversation

themr0c
Copy link
Member

@themr0c themr0c commented Jan 30, 2025

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.6

Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5491

Depends on: backstage/backstage#27821

@rhdh-bot
Copy link
Collaborator

Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might consider taking a consistent approach to configuration examples across all RHDH going forward (by using variables, definitions, and consistent lead-in sentences), but this is "technically" correct from a peer review standpoint. Approved.

Comment on lines +162 to +175
`sessionDuration`::
Lifespan of the user session.
Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
+
.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
[source,yaml,subs="+quotes"]
----
auth:
providers:
github:
production:
sessionDuration: { hours: 24 }
----

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just an example / future consideration for clear and consistent configuration examples across RHDH docs.

Suggested change
`sessionDuration`::
Lifespan of the user session.
Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
+
.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
[source,yaml,subs="+quotes"]
----
auth:
providers:
github:
production:
sessionDuration: { hours: 24 }
----
+
. (Optional) In your`app-config-rhdh.yaml` file, configure the `sessionDuration` field. For example:
+
[source,yaml,subs="+quotes"]
----
auth:
providers:
github:
production:
sessionDuration: { <session-duration> } (1)
----
<1> Lifespan of the user session in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user cannot copy and paste the proposed example. This would decrease usability for the user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants