Skip to content

Commit 41d5513

Browse files
Minor docs updates
1 parent b000e04 commit 41d5513

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

docs/hub/guides/ccm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The management hub will have complete control over the Certify Certificate Manag
2626

2727
## Joining the Hub
2828

29-
By default a joining API key is created when you install the hub. This is found under Settings > Security > API Access. You will need the API URL, Client Id and Client Secret values.
29+
By default a joining API key is created when you install the hub. This is found under *Settings > Security > API Access*. You will need the API URL (e.g. `https://hub.internal.yourdomain.com:9697` depending on your configuration), Client Id and Client Secret values.
3030

3131
### Method 1: Using the Desktop User Interface
3232

@@ -54,7 +54,7 @@ After joining, confirm that your instance appears in the Management Hub UI's **I
5454

5555
# Using the Hub to manage a CCM instance
5656

57-
Your *Certify Certificate Manager* install remains much the same as it was before, except it can also be externally managed via the hub. When you are working with individual setting such as Stored Credentials, Certificate Authority accounts etc these remain per-instance settings, so each instance of the app has it's own set of settings and you will selected the target instance when working with those.
57+
Your existing *Certify Certificate Manager* install remains much the same as it was before, except it can also be externally managed via the hub. When you are working with individual settings such as Stored Credentials, Certificate Authority accounts etc these remain per-instance settings, so each instance of the app has it's own set of settings and you will selected the target instance when working with those.
5858

5959
The hub does not currently have global settings that can be pushed to all managed instances etc (such as a single ACME account, or specific stored credential).
6060

docs/hub/installation/service.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ An example config is included in the file to use a PFX file, so to setup https:
1414

1515
- Decide on your preferred fully qualified service name for the hub, e.g. `certifyhub.intranet.yourdomain.com`
1616
- 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.
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.
1818

1919
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.:
2020

@@ -35,6 +35,8 @@ Once you have a cert on disk you are ready to configure the service to use that
3535
}
3636
```
3737

38-
Then restart the `Certify Management Hub` service, you can then access the service via https e.g. `https://certifyhub.intranet.yourdomain.com`
38+
Then restart the `Certify Management Hub` service, you can then access the service via https at the port you specified e.g. `https://certifyhub.intranet.yourdomain.com:9697` - do not expose your installation (e.g. open the port) to the public internet.
3939

40-
This is an example configuration, so you can configure the endpoints and certificates however you prefer.
40+
This is an example configuration, so you can configure the endpoints and certificates however you prefer.
41+
42+
Note that when using the app remotely the UI (e.g. via Tailscale etc) may take a while to load the WASM files etc for the first time, subsequent loads are much faster.

docs/hub/installation/windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The current default configuration will make the service and UI available at `htt
1919

2020
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

22-
Do not install the Hub service where you also want to use Certify Certificate Manager as they will share the same settings/databases via different services which could create confusion or conflicts and is not a supported configuration. You can however upgrade a Certify Certificate Manager install to be a hub: uninstall Certify Certificate Manager (the desktop app_ first, install Certify Management Hub, then use the hub to administer your certificates as normal.
22+
Do not install the Hub service where you also want to use Certify Certificate Manager as they will share the same settings/databases via different services which could create confusion or conflicts and is not a supported configuration. You can however upgrade a Certify Certificate Manager install to be a hub: uninstall Certify Certificate Manager (the desktop app) first, install Certify Management Hub, then use the hub to administer your certificates as normal.
2323

2424
### Settings are preserved between installs/upgrades
2525
On Windows your settings are preserved in `%PROGRAMDATA%\certify`. For most users, this is `C:\ProgramData\certify`. Uninstalling the app or installing a new version does not remove the files stored here. We recommend including this location in your regular backup procedure.

docs/hub/managedchallenges.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Under *Settings > Security > API Access*, select Add API Token, select the requi
5757
8. Copy the **Client ID** and **Secret** values - you'll need these for instance configuration
5858

5959
#### Combined Hub joining and Managed Challenge Key
60-
It is possible to create a combined hub joining key and managed challenge key, which certain clients (such as Certify Certificate Manager) can use by default if they already know the hub joining key. This is provided as an option for convinience but is not configured by default.
60+
It is possible to create a combined hub joining key and managed challenge key, which certain clients (such as Certify Certificate Manager) can use by default if they already know the hub joining key. This is provided as an option for convenience but is not configured by default.
6161

6262
To enable this, add the Managed Challenge Consumer role to the managed instance service principle (or a new service principle), then create a new hub joining key with both the *Hub Managed Instance* role and *Managed Challenge Consumer* role scope.
6363

0 commit comments

Comments
 (0)