Skip to content

Commit a537506

Browse files
Update CCM hub docs
1 parent e2b2f9f commit a537506

File tree

1 file changed

+40
-37
lines changed

1 file changed

+40
-37
lines changed

docs/hub/guides/ccm.md

Lines changed: 40 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Joining your existing *Certify Certificate Manager* (CCM) instance to a Manageme
88

99
To use Certify Management Hub with existing installations:
1010

11-
1. Set up a Joining API key in the hub
11+
1. Set up a Joining API key in the hub (one is automatically created when the hub is installed).
1212
2. Configure CCM to join the hub (via UI or command line)
1313
3. Verify that the joining has completed in the hub UI
1414

@@ -24,6 +24,41 @@ The management hub will have complete control over the Certify Certificate Manag
2424

2525
:::
2626

27+
## Joining the Hub
28+
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.
30+
31+
### Method 1: Using the Desktop User Interface
32+
33+
1. In *Certify Certificate Manager*, go to **Settings > Management Hub**
34+
2. Enter the following:
35+
- Management Hub API URL
36+
- Client ID
37+
- Client Secret
38+
3. Click **Join**
39+
4. The app will attempt to join the management hub
40+
5. If successful, the instance will appear in the **Instances** list of the Management Hub UI and managed certificates will be shown in the hub.
41+
42+
### Method 2: Using the Command Line
43+
44+
If you need to automate joining for a large number of instances you may prefer to script using the command line. To do so, run the following command (from `C:\Program Files\CertifyTheWeb\` as a member of Administrators):
45+
46+
```
47+
certify hub join <url of mgmt hub API> <client id> <client secret>
48+
```
49+
50+
## Verification
51+
52+
After joining, confirm that your instance appears in the Management Hub UI's **Instances** list.
53+
54+
55+
# Using the Hub to manage a CCM instance
56+
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.
58+
59+
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).
60+
61+
## Other Considerations
2762
### Ensure Unique Instance IDs
2863

2964
When CCM is installed, an InstanceID value is generated and stored in appsettings.json (on Windows).
@@ -37,7 +72,9 @@ Instance IDs must be valid (unique) GUID values. If in doubt:
3772
1. Delete your `appsettings.json` file (or just the instanceID field)
3873
2. Restart the Certify background service to let the app create a new one
3974

40-
## Setting Up the Hub for Instance Management
75+
## Setting up additional joining keys
76+
77+
If you manage instances across different organizations (e.g. if you are an MSP etc), consider creating multiple joining keys to partition by organization. This allows you to revoke hub access for specific groups without affecting unrelated instances.
4178

4279
### 1. Add a Security Principle for Managed Instances
4380

@@ -53,8 +90,6 @@ This step may be unnecessary in current versions where it's auto-created.
5390
5. Select the `Management Hub Managed Instance` role from Available Roles
5491
6. Click **Save**
5592

56-
**Note for MSPs:** If you manage instances across different organizations, consider creating multiple joining keys to partition by organization. This allows you to revoke hub access for specific groups without affecting unrelated instances.
57-
5893
### 2. Create an API Key for Joining Instances
5994

6095
1. Navigate to **Settings > Security > API Access**
@@ -64,36 +99,4 @@ This step may be unnecessary in current versions where it's auto-created.
6499
5. Select **Management Hub Managed Instance** as the scoped role
65100
6. **Important:** Click **Add/Remove Role Scope** to add it to the scope list
66101
7. Click **Add** to create the new API token
67-
8. Copy the **Client ID** and **Secret** values - you'll need these for instance configuration
68-
69-
## Joining the Hub
70-
71-
### Method 1: Using the CCM User Interface
72-
73-
1. In *Certify Certificate Manager*, go to **Settings > Management Hub**
74-
2. Enter the following:
75-
- Management Hub API URL
76-
- Client ID
77-
- Client Secret
78-
3. Click **Join**
79-
4. The app will attempt to join the management hub
80-
5. If successful, the instance will appear in the **Instances** list of the Management Hub UI
81-
82-
### Method 2: Using the Command Line
83-
84-
Run the following command:
85-
86-
```
87-
certify hub join <url of mgmt hub API> <client id> <client secret>
88-
```
89-
90-
## Verification
91-
92-
After joining, confirm that your instance appears in the Management Hub UI's **Instances** list.
93-
94-
95-
# Using the Hub to manage a CCM instance
96-
97-
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.
98-
99-
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).
102+
8. Copy the **Client ID** and **Secret** values - you'll need these for instance configuration

0 commit comments

Comments
 (0)