Skip to content

Commit 43a3e44

Browse files
Add hub service config doc
1 parent ddaa73b commit 43a3e44

File tree

2 files changed

+42
-2
lines changed

2 files changed

+42
-2
lines changed

docs/hub/installation/service.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Hub Service Config
3+
---
4+
5+
## Port and TLS Certificate
6+
By default the hub service will initially be created on `http://localhost:8080` which generally means it can't be used from other machines and it also doesn't have https enabled (the irony!).
7+
8+
A default sample config is created at `C:\ProgramData\certify\hubservice.json` or `/usr/share/certify/hubservice.json` and this allows you to customise the http listener, which is a .net Kestrel web server:
9+
10+
https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-9.0
11+
12+
13+
An example config is included in the file to use a PFX file, so to setup https:
14+
15+
- Decide on your preferred fully qualified service name for the hub, e.g. `certifyhub.intranet.yourdomain.com`
16+
- Use the management hub to acquire a certificate for the service name you need, using the normal certificate request process.
17+
- Add a Deployment Task (Export Certificate) to export a PFX (PKCS#12) file to where it's required e.g. C:\ProgramData\certify\internal-certs\hub.pfx , then run the task to export the initial certificate.
18+
19+
Once you have a cert on disk you are ready to configure the service to use that cert file, edit the `hubservice.json` file to include the `HttpsInlineCertFile` entry. The choice of port and filename etc is arbitrary, as long as the process can access the file.:
20+
21+
```json
22+
"Kestrel": {
23+
"Endpoints": {
24+
"SvcHttpEndpoint": {
25+
"Url": "http://0.0.0.0:8080"
26+
},
27+
"HttpsInlineCertFile": {
28+
"Url": "https://0.0.0.0:9697",
29+
"Certificate": {
30+
"Path": "C:\\ProgramData\\certify\\internal-certs\\hub.pfx",
31+
"Password": ""
32+
}
33+
},
34+
}
35+
}
36+
```
37+
38+
Then restart the `Certify Management Hub` service, you can now access the service via https e.g. `https://
39+
40+
This is an example configuration, so you can configure the endpoints and certificates however you prefer.

docs/hub/installation/windows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Install as a single combined management hub service, this is the simplest method
1515

1616
You can download the latest **alpha test** version [7.0.0.16-alpha.03 : Released 2025/05/03](https://certifytheweb.s3.amazonaws.com/downloads/archive/CertifyMgmtHubSetup_V7.0.0-alpha.03.exe) - this is intended for test evaluation and not for production use, as subsequent updates may including breaking changes.
1717

18-
The current default configuration will make the service and UI available at `http://localhost:5000` and you will need to set the API endpoint (the same URL) in the login UI. This will change in subsequent releases.
18+
The current default configuration will make the service and UI available at `http://localhost:8080` and you will need to set the API endpoint (the same URL) in the login UI.
1919

20-
To use the service with https you currently need to reverse proxy from IIS or any other https enabled web server. This will change in a subsequent update.
20+
To use the service with https you can either [configure the service to use https](service.md) or reverse proxy the service from a webserver of your choice (Caddy, IIS, nginx, Apache etc and administer https on those as normal).
2121

2222
### Install as multiple services, possibly on different servers etc.
2323
- Or, if you need more control over how things are organized, install the components separately:

0 commit comments

Comments
 (0)