Skip to content

Commit 50eaf16

Browse files
zdrawkuzdrawku
authored
Merge pull request #245 from IgniteUI/on-prem-topic
On-prem docs
2 parents 5a98710 + 47fd15b commit 50eaf16

File tree

6 files changed

+153
-3
lines changed

6 files changed

+153
-3
lines changed

‎en/docfx.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"spa-and-navigation/**.md",
1313
"using-data-in-your-app/**.md",
1414
"ui-kits/**.md",
15+
"on-premises/**.md",
1516
"toolbox/**.md",
1617
"how-to/**.md",
1718
"sidebar-toc/toc.yml",

‎en/on-prem-prerequisites-and-installation.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ docker run --restart always -p 80:5000 -e "ConnectionStrings:Provider=SqlServer"
114114
<img class="box-shadow" src="./images/docker-apps.png" />
115115
<p style="margin-top:-20px;text-align:center;">Docker Containers/Apps</p>
116116

117+
### Authentication with OpenID Connect (OAuth 2.0)
118+
119+
Follow the [On-Prem Authentication with OpenID Connect (OAuth 2.0)](on-premises/auth-with-openid-connect-o-auth.md) topic for more information.
120+
117121
### Updates
118122

119123
1 - Follow the first 4 steps of the first time installation with the newly published zip file
@@ -163,6 +167,7 @@ Docker Desktop on Windows is not starting automatically without Login to Windows
163167
## Additional Resources
164168
<div class="divider--half"></div>
165169

170+
* [On-Prem Authentication with OpenID Connect](on-premises/auth-with-openid-connect-o-auth.md)
166171
* [App Builder Interface Overview](interface-overview.md)
167172
* [Single Page And Navigation](single-page-apps-and-navigation.md)
168173
* [App Builder Components](indigo-design-app-builder-components.md)

‎en/on-premises/auth-with-openid-connect-o-auth.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# On-Prem Authentication with OpenID Connect (OAuth 2.0)
2+
3+
This document aims to provide configuration instructions on how to configure custom authentication providers for the App Builder on-premise instance by using OpenID Connect server supporting OAuth 2.0 CODE authorization flow with PKCE.
4+
5+
The guide includes:
6+
7+
- Required OIDC client settings.
8+
- Configuration settings specific to App Builder.
9+
- Additional options such as oidc_scope and oidc_redirect_uri.
10+
11+
## Settings for the OIDC Client
12+
13+
- OAuth2 Flow: Authorization Code + PKCE
14+
- Refresh tokens enabled (`offline_access` scope),
15+
- Access token lifetime: (suggested 600 seconds)
16+
- Refresh token lifetime: sliding window recommended with a minimum of 1 hour (24hs recommended) and max life determined by the organization or unlimited).
17+
- Include User claims in Id Token (there are two required standard claims: "sub" & "email" and two optional custom claims "given_name" & "family_name")
18+
- Required scopes: openid email profile offline_access appbuilder.user
19+
- Audience: "appbuilder" (default)
20+
- Sign in redirect uri: <app builder host>/oidc/ig/callback
21+
- Post logout url: <app builder host>/oidc/ig/callback-postlogout
22+
23+
## Settings for App Builder
24+
25+
### Required configuration settings
26+
- AuthSettings__SkipAuth: false
27+
- AuthSettings__Authority: _OpenId server URL_
28+
- AuthSettings__ClientId: _OpenId Client Id_
29+
- AuthSettings__AccountIssuer: _Server Unique Alias_
30+
31+
### Other options
32+
- oidc_scope: 'openid email offline_access profile appbuilder.user' (default)
33+
- oidc_redirect_uri: '/oidc/ig/callback', (default)
34+
- oidc_post_logout_redirect_uri: /oidc/ig/callback-postlogout' (default)
35+
- AuthSettings:Audience: "appbuilder" (default)
36+
37+
> [!NOTE]
38+
> To use the OIDC auth you need to set the FrontendOptions_SkipAuth setting to false.
39+
40+
After setting up your OIDC client you’ll need to pass 3 required properties to App Builder docker container as environment variables:
41+
42+
e.g.
43+
```sh
44+
docker run --restart always -p 80:5000 -e ConnectionStrings__Provider=SqlServer -e "ConnectionStrings:...." -e AuthSettings__SkipAuth=false -e AuthSettings__Authority="https://my-auth-server.example.com" -e AuthSettings__ClientId="1234-4657-00" -e AuthSettings__AccountIssuer="MyAuth" -v "C:\ProgramData\Infragistics\Appbuilder\logs:/appbuilder/logs" -v "C:\ProgramData\Infragistics\Appbuilder\storage:/appbuilder/storage" --name appbuilder appbuilder:1.0
45+
```
46+
47+
## Additional Resources
48+
<div class="divider--half"></div>
49+
50+
* [On-prem Prerequisites and Installation Overview](../on-prem-prerequisites-and-installation.md)
51+
* [App Builder Interface Overview](../interface-overview.md)

‎en/on-premises/configuration-flags.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Configuration flags upon On-Prem and SDK deployment
2+
3+
This document is outlining the available configuration flags for deploying and managing the App Builder on-premise instance. This document should provide examples of key environment variables, such as:
4+
5+
```sh
6+
docker run --restart always -p 80:5000 -e AuthSettings__ClientId="1234-4657-00"
7+
```
8+
9+
## Configurable properties
10+
11+
### Through environment.ts (part of App Builder SDK context)
12+
13+
```
14+
// Configuration Property Explanations:
15+
16+
- favicon: '/favicon_dev.ico', // Enables you to set your own favicon
17+
- disableSurvey: false, // Disables App Builder surveys
18+
- enableLibrariesManagement: false, // Shows/hides the dropdown for library management
19+
- disablePublishToGithub: false, // Disables/enables the "Publish to GitHub" button
20+
- disableFeedback: false, // Toggles Feedback dialog visibility
21+
- showOnboardingVideos: false, // Toggles the onboarding YouTube videos
22+
- toggleableDatasourceTags: false, // Toggles the visibility of data source color tags
23+
- hideMainMenu: false, // Toggles the visibility of the Application Shell Main Menu
24+
- personalWorkspaceLabel: 'myProjects', // Sets the label value for the personal workspace
25+
- disableCodegen: false, // Toggles the usage of the Codegeneration service
26+
- hideSharingOptions: false, // Toggles the visibility of sharing options in the UI
27+
- hideHelpResources: false, // Hides help resources in the interface
28+
- hideAppBuilderLogo: false, // Hides the App Builder logo
29+
- disableQuickTips: false, // Disables Quick tips
30+
- hideMockDataSources: false, // Hides mock data sources from the UI
31+
- hideVerbPills: false, // Hides HTTP verb pills in API-related features
32+
- useSummaryForOperationName: false, // Uses a summary instead of a full name for operation names
33+
- showObjectDatasources: false, // Enables support for object-based datasources (limited use case)
34+
- hideDesktopApp: false, // Hides desktop app-related options in the UI
35+
- hideAccountMenu: false, // Hides the account menu from the UI
36+
- hideExperimentalGenerators: [], // Specifies frameworks to hide from code export (e.g., [{ platform: Platform.react }])
37+
- disableMockDataUponFailedEndpoint: false, // Prevents mock data from being used if an endpoint fails
38+
- disableAI: false, // Disables AI-related features
39+
- enableCssGridLayout: true, // Enables the CSS Grid layout feature
40+
- showPreviewInvite: true, // Shows preview invites for collaborative features
41+
42+
// Theme Properties:
43+
44+
appTheme: {
45+
schema: 'light-bootstrap-schema', // Defines the base theme schema
46+
colors: {
47+
primary: '#2D8DFF', // Primary color used throughout the application
48+
secondary: '#2D8DFF', // Secondary color
49+
surface: '#F1F7FF',
50+
success: '#31AB2B', // Success indicator color
51+
warn: '#F2C200', // Warning indicator color
52+
error: '#DB372A', // Error indicator color
53+
info: '#0678FF', // Info indicator color
54+
grays: '#2F2F2F',
55+
},
56+
typeface: 'Public Sans', // Default font for the application
57+
fonts: [], // Additional font families
58+
scale: 'bootstrap-type-scale',
59+
roundness: 0.3, // Corner roundness
60+
elevation: null, // Elevation (shadows), if applicable
61+
},
62+
63+
shellTheme: {
64+
typeface: 'Public Sans', // Font used in the application shell
65+
colors: {
66+
primary: '#2D8DFF', // Primary color
67+
grays: '#9A9DA2',
68+
success: '#31AB2B', // Success indicator color
69+
warn: '#F2C200', // Warning color
70+
error: '#DB372A', // Error color
71+
aux1: '#068E6B',
72+
aux2: '#9C27B0',
73+
},
74+
}
75+
```
76+
77+
### Through a parameter in a docker run command (On-prem context)
78+
79+
```sh
80+
docker run --restart always -p 80:5000 -e AuthSettings__ClientId="1234-4657-00"
81+
```
82+
83+
## Additional Resources
84+
<div class="divider--half"></div>
85+
86+
* [Auth with openid connect](auth-with-openid-connect-o-auth.md)
87+
* [On-prem Prerequisites and Installation Overview](../on-prem-prerequisites-and-installation.md)
88+
* [App Builder Interface Overview](../interface-overview.md)

‎en/sidebar-toc/toc.yml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99
items:
1010
- name: On-premises prerequisites and installation
1111
href: ../on-prem-prerequisites-and-installation.md
12+
updated: true
13+
- name: Auth with OpenID Connect
14+
href: ../on-premises/auth-with-openid-connect-o-auth.md
15+
new: true
16+
- name: Configuration flags for On-prem and SDK
17+
href: ../on-premises/configuration-flags.md
18+
new: true
1219
- name: Running Desktop App
1320
href: ../running-desktop-app.md
1421
- name: Share, Preview and Edit apps
@@ -21,9 +28,6 @@
2128
- name: Figma
2229
href: ../ui-kits/figma.md
2330
new: false
24-
#name: Adobe XD
25-
#href: ../ui-kits/adobe-xd.md
26-
#new: false
2731
- name: Sketch
2832
href: ../ui-kits/sketch.md
2933
new: false

‎jp/docfx.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"spa-and-navigation/**.md",
1313
"using-data-in-your-app/**.md",
1414
"ui-kits/**.md",
15+
"on-premises/**.md",
1516
"toolbox/**.md",
1617
"how-to/**.md",
1718
"sidebar-toc/toc.yml",

0 commit comments

Comments
 (0)