Skip to content

Commit a0ce53e

Browse files
Add OIDC provider docs
1 parent 684ccb3 commit a0ce53e

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed

docs/hub/guides/oidc.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Configuring and using OpenID Connect (OIDC)
2+
3+
The hub can be configured to allow users to sign in by authenticating against an external OIDC provider such as Azure Entra.
4+
5+
## Configure an OIDC provider
6+
7+
You can add the configuration for a new OIDC provider under Settings > Security > OpenID Connect (OIDC).
8+
9+
You will need to provide:
10+
- **Provider Name** for display on the sign in screen
11+
- **Authority URL** e.g. `https://login.microsoftonline.com/<your tenant id>`
12+
- **Client ID**
13+
- **Client Secret**
14+
- **OpenID Scopes**, at a minimum `openid`
15+
- **Response Type**: `code`
16+
- **Response Mode**: `form_post`
17+
18+
## Signing In
19+
20+
Once an OIDC provider is configured, any user can try to sign in using that provider. A stub account will then be created within the system with no roles assigned. The administrator can then assign hub roles to that account. When the user signs back in they will have the assigned roles and feature access.

docs/hub/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The product is available to try out as an beta version (e.g. not the finished pr
1616
- **Self-hosted, cross-platform including Linux, macOS or Windows.**
1717
- Optionally manage thousands of certs across hundreds of existing *Certify Certificate Manager* instances, or renew centrally, from a "single pane of glass" UI.
1818
- Multi-user role based access security for administration and consuming certificates, with support for app/service security principles and individual scoped API access
19+
- Optional single sign on with [OIDC support](./guides/oidc.md) via providers such as Azure Entra.
1920
- Distribute certs using optional installed agents, deployment tasks, or use the API to pull the latest cert using your own integrations.
2021
- Optional centralized DNS challenges compatible with most popular ACME clients, so that privileged DNS credentials do not need to be stored across individual ACME clients.
2122
- Optional integrated visibility of renewal status for third party ACME clients such as win-acme, Certbot and acme.sh

docs/hub/known-issues.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,11 @@ The UI needs to know the URL of the API it should talk to. This is configured by
1515

1616
If the problem occurs with a new docker container, follow the above and set the url to the require host and port e.g. `http://localhost:8080`
1717

18-
#### Refreshing a page returns a blank page
19-
If using the combined hub service container image or serving the UI via the same service as the API, some app UI routing does not work (e.,g. reloading or bookmarking in-app URL routes).
18+
#### Data caching in the UI
19+
Normally, when the system changes managed certificate or updates it status the change should be streamed back to the UI via SignalR. This streaming functionality is currently a work in progress and most items now update automatically.
2020

2121
Pages that show data that might change will generally update themselves periodically (summary page, instances, charts etc) or in some cases when the underlying data changes and a message from the hub is streamed back the the UI. In some cases you may need to reload the app from the app root URL to see the latest information while the app is still under development.
2222

23-
#### When managed certificates change, the info doesn't update in the UI
24-
Normally, when the system changes managed certificate or updates it status the change should be streamed back to the UI via SignalR. This streaming functionality is currently a work in progress and most items now update automatically.
25-
2623
#### Loading time over slow connections
2724
The web app uses WebAssembly (WASM) and has a large application payload on initial load. Subsequent loads used cached resources.
2825

@@ -34,4 +31,5 @@ Multiple instances of the Certify Agent or Management Hub service reading and wr
3431

3532
Note: We do not provide general support for how to use different container technology and you will likely need to know more about your choice of container deployment technology than we do, if you are using containers at all. Certify Management Hub is our first product that supports deployment to containers, so we expect growing pains.
3633

37-
34+
### Windows Specific Tasks
35+
If you will be commonly running PowerShell etc and interacting with Windows Server using Windows AAuthentication you should host the Management Hub on a Windows Server install. The hub *can* be used in containers (or hosted directly on Linux) but with reduced compatibility for Windows specific things like Windows Impersonation credentials.

0 commit comments

Comments
 (0)