Skip to content

Commit 9697ebc

Browse files
themr0cGitHub Actions
themr0c
authored and
GitHub Actions
committed
RHIDP-5491 configure expiry on refresh token cookie (#899)
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header Update the configure global header
1 parent 78e21c3 commit 9697ebc

File tree

7 files changed

+174
-0
lines changed

7 files changed

+174
-0
lines changed

‎assemblies/assembly-customizing-the-global-header.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: customizing-the-global-header
3+
[id="assembly-customizing-red-hat-developer-hub-global-header"]
4+
= Customizing the {product} global header
5+
6+
As an administrator, you can enable or disable the {product} global header to create a consistent and flexible navigation bar across your {product-custom-resource-type} instance. You can extend the global header with additional buttons and customize the order and position of icons and features. By default, the {product} global header includes a search field, create, support and notification buttons, and a user profile drop-down.
7+
8+
include::modules/customizing-the-global-header/proc-customizing-rhdh-global-header.adoc[leveloffset=+1]

‎modules/authentication/proc-enabling-authentication-with-github.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,20 @@ auth:
161161
----
162162
////
163163

164+
`sessionDuration`::
165+
Lifespan of the user session.
166+
Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
167+
+
168+
.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
169+
[source,yaml,subs="+quotes"]
170+
----
171+
auth:
172+
providers:
173+
github:
174+
production:
175+
sessionDuration: { hours: 24 }
176+
----
177+
164178
[TIP]
165179
====
166180
To enable GitHub integration with a different authentication provider, complete the following configurations:

‎modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,21 @@ auth:
133133
additionalScopes:
134134
- Mail.Send
135135
----
136+
137+
`sessionDuration`::
138+
Lifespan of the user session.
139+
Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
140+
+
141+
.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
142+
[source,yaml,subs="+quotes"]
143+
----
144+
auth:
145+
providers:
146+
microsoft:
147+
production:
148+
sessionDuration: { hours: 24 }
149+
----
150+
136151
--
137152

138153
[NOTE]

‎modules/authentication/proc-enabling-authentication-with-rhbk.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,20 @@ auth:
163163
----
164164
--
165165

166+
`sessionDuration`::
167+
Lifespan of the user session.
168+
Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
169+
+
170+
.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
171+
[source,yaml,subs="+quotes"]
172+
----
173+
auth:
174+
providers:
175+
github:
176+
production:
177+
sessionDuration: { hours: 24 }
178+
----
179+
166180
`auth.backstageTokenExpiration`::
167181
--
168182
To modify the {product-short} token expiration from its default value of one hour, note that this refers to the validity of short-term cryptographic tokens, not the session duration. The expiration value must be set between 10 minutes and 24 hours.

‎modules/customizing-the-global-header/proc-customizing-rhdh-global-header.adoc‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
[id="customizing-your-product-global-header_{context}"]
2+
= Customizing your {product} global header
3+
4+
By default, the {product} global header includes a search field, create, support and notification buttons, and a user profile drop-down.
5+
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
6+
Using dynamic plugins, you can extend the global header with additional buttons and customize the order and position of icons and features. For more information on enabling dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
7+
8+
Include the following attributes in your global header entry:
9+
10+
`mountPoint`::
11+
Defines where the header will be added. Use `application/header` to specify it as a global header.
12+
13+
`importName`::
14+
Specifies the component exported by the global header plugin.
15+
16+
`config.layout.position`::
17+
Determines the header's position. Supported values are `above-main-content` and `above-sidebar`.
18+
19+
[NOTE]
20+
====
21+
You can configure several global headers at different positions by adding entries to the `mountPoints` field.
22+
====
23+
24+
.Prerequisites
25+
* You have configured your {product-custom-resource-type} instance.
26+
* You have configured the support URL in the `{my-app-config-file}` file.
27+
* You have installed the notification plugin.
28+
29+
.Procedure
30+
31+
. Install your own header as a dynamic plugin. For example, add the following plugin definition to your `dynamic-plugins.default.yaml` file:
32+
+
33+
.`dynamic-plugins.yaml` fragment
34+
[source,yaml,subs="+attributes,+quotes"]
35+
----
36+
- package: `_<npm_or_oci_package-reference>_`
37+
disabled: false
38+
pluginConfig:
39+
dynamicPlugins:
40+
frontend:
41+
<package_name>:
42+
mountPoints:
43+
- mountPoint: application/header
44+
importName: `_<Header_component_name>_`
45+
config:
46+
position: above-main-content
47+
----
48+
+
49+
[NOTE]
50+
====
51+
`importName` is an optional name referencing the value returned by the scaffolder field extension API.
52+
====
53+
. To disable the global header, disable the right plugin in your `dynamic-plugins.yaml` file as follows:
54+
+
55+
.`dynamic-plugins.yaml` fragment
56+
[source,yaml,subs="+attributes,+quotes"]
57+
----
58+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
59+
disabled: true
60+
----

‎modules/customizing/proc-customizing-product-global-header.adoc‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
[id="customizing-your-product-global-header_{context}"]
2+
= Customizing your {product} global header
3+
4+
By default, the {product} global header includes a search field, create, support and notification buttons, and a user profile drop-down.
5+
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
6+
Using dynamic plugins, you can extend the global header with additional buttons and customize the order and position of icons and features. For more information on enabling dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
7+
8+
Include the following attributes in your global header entry:
9+
10+
`mountPoint`::
11+
Defines where the header will be added. Use `application/header` to specify it as a global header.
12+
13+
`importName`::
14+
Specifies the component exported by the global header plugin.
15+
16+
`config.layout.position`::
17+
Determines the header's position. Supported values are `above-main-content` and `above-sidebar`.
18+
19+
[NOTE]
20+
====
21+
You can configure several global headers at different positions by adding entries to the `mountPoints` field.
22+
====
23+
24+
.Prerequisites
25+
* You have configured your {product-custom-resource-type} instance.
26+
* You have configured the support URL in the `{my-app-config-file}` file.
27+
* You have installed the notification plugin.
28+
29+
.Procedure
30+
31+
. Install your own header as a dynamic plugin. For example, add the following plugin definition to your `dynamic-plugins.default.yaml` file:
32+
+
33+
.`dynamic-plugins.yaml` fragment
34+
[source,yaml,subs="+attributes,+quotes"]
35+
----
36+
- package: `_<npm_or_oci_package-reference>_`
37+
disabled: false
38+
pluginConfig:
39+
dynamicPlugins:
40+
frontend:
41+
<package_name>:
42+
mountPoints:
43+
- mountPoint: application/header
44+
importName: `_<Header_component_name>_`
45+
config:
46+
position: above-main-content
47+
----
48+
+
49+
[NOTE]
50+
====
51+
`importName` is an optional name referencing the value returned by the scaffolder field extension API.
52+
====
53+
. To disable the global header, disable the right plugin in your `dynamic-plugins.yaml` file as follows:
54+
+
55+
.`dynamic-plugins.yaml` fragment
56+
[source,yaml,subs="+attributes,+quotes"]
57+
----
58+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
59+
disabled: true
60+
----

‎titles/customizing/master.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ include::artifacts/attributes.adoc[]
1111
include::modules/customizing/proc-customizing-your-product-title.adoc[leveloffset=+1]
1212

1313

14+
include::modules/customizing/proc-customizing-product-global-header.adoc[leveloffset=+1]
15+
16+
1417
include::modules/customizing/proc-customizing-your-product-base-url.adoc[leveloffset=+1]
1518

1619

0 commit comments

Comments
 (0)