Skip to content

Commit 0140341

Browse files
Update agent guidance and sidebar nav
1 parent c52b6e3 commit 0140341

File tree

8 files changed

+89
-11
lines changed

8 files changed

+89
-11
lines changed

docs/hub/guides/agent.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Certify Management Agent (Linux, macOS)
3+
---
4+
5+
## Summary
6+
7+
The *Certify Management Agent* is a service which can be use on Linux or macOS to perform certificate renewals and deployment tasks, or to monitor renewals managed by external certificate managers (including Certbot, acme.sh, win-acme/simple-acme and Posh-ACME). The agent is functionally the same as [Certify Certificate Manager](ccm.md) on Windows, but without a Desktop UI.
8+
9+
## Installation and Upgrades
10+
11+
See our [install guide](../installation/linux#certify-management-agent) for details installing and upgrading.
12+
13+
## Joining the Management Hub
14+
15+
Joining your existing *Certify Management Agent* instance to a Management Hub allows you to control the instance settings, renewals and monitoring.
16+
17+
The basic steps are:
18+
19+
1. Set up a Joining API key in the hub (one is automatically created when the hub is installed).
20+
2. Configure the agent to join the hub (via the command line)
21+
3. Verify that the joining has completed in the hub UI
22+
23+
## Before Joining the Hub
24+
25+
### Security Considerations
26+
27+
:::warning Important
28+
29+
The Management Hub will have complete control over the Certify Management Agent instance settings, including the ability to specify deployment tasks which may include locally executed code (PowerShell etc).
30+
31+
**Do not join a hub you don't control or trust.**
32+
33+
:::
34+
35+
## Joining the Hub
36+
37+
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.
38+
39+
```
40+
curl -X POST http://127.0.0.2:9696/api/system/hub/join -H 'Content-Type: application/json' -d '{"clientId":"managedinstance_sp_01","secret":"<secret>","url":"<hub url>"}'
41+
```
42+
43+
## Verification
44+
45+
After joining, confirm that your instance appears in the Management Hub UI's **Instances** list.
46+
47+
## Using the Hub to manage the agent
48+
49+
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
50+
instance when working with those.
51+
52+
### Monitoring External Certificate Managers
53+
54+
The agent can provide monitoring of renewals that are managed by a selected number of ACME certificate management tools including Certbot, acme.sh, win-acme/simple-acme and Posh-ACME.
55+
56+
With your agent installed on your target machine and joined to the hub, configure the paths for your chosen certificate manager under *Settings > General > External Certificate Managers*, ensuring to select your target instance from the Target Instance dropdown list at the top the page. By default the system will attempt to discover existing config using the default paths. Configuration of log paths is only required where logs are stored separately from the other config (e.g. Certbot).
57+
58+
| Cert Manager | Default Config Path | Default Log Path |
59+
|---|---|---|
60+
| acme.sh | ~/.acme.sh/ | - |
61+
| certbot | /etc/letsencrypt | /var/log/letsencrypt |
62+
| posh-acme | %APPDATA%\Local\Posh-ACME | - |
63+
| simple-acme | %PROGRAMDATA%\simple-acme | - |
64+
| win-acme | %PROGRAMDATA%\simple-acme | - |
65+
66+
The agent will cache results from each certificate manager and periodically refresh results, so changes to renewals etc will take a few minutes to show up in the hub UI.

docs/hub/guides/ccm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
title: Joining the Hub
2+
title: Certify Certificate Manager (Desktop)
33
---
44

55
## Summary
66

77
Joining your existing *Certify Certificate Manager* (CCM) instance to a Management Hub allows you to control the instance settings as if you were working in the conventional desktop app, without having to remote into the desktop of each instance.
88

9+
If you are using *Certify Management Agent* on Linux or macOS, [see our agent guide](agent.md).
10+
911
Start by [downloading the latest version](https://downloads.certifytheweb.com/beta/latest/certify-ccm-windows-x64-latest.exe) of Certify Certificate Manager (v7+) with the option to connect to a management hub.
1012

1113
To use Certify Management Hub with existing installations:

docs/hub/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ title: Getting Started
77

88
*Certify Management Hub* is our new cross-platform product for centralized administration of managed certificates.
99

10-
:::warning[Alpha Version]
10+
:::warning[Beta Version]
1111

12-
The product is available to try out as an alpha version (e.g. not the finished product). The documentation shown here is provisional and subject to major changes. To provide feedback contact `support at certifytheweb.com` or post to https://community.certifytheweb.com/. If testing, see current [Known Issues](known-issues.md)
12+
The product is available to try out as an beta version (e.g. not the finished product). The documentation shown here is provisional and subject to major changes. To provide feedback contact `support at certifytheweb.com` or post to https://community.certifytheweb.com/. If testing, see current [Known Issues](known-issues.md)
1313
:::
1414

1515
**All the core features of [Certify Certificate Manager](../intro.md), with a web based management UI and API.**

docs/hub/installation/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ For simplest setup you can fetch the combined Certify Management Hub image from:
5858
Add Storage > persistent volume claim `certifydata` with mount path `/usr/share/certifydata`, see also `CERTIFY_APP_DATA` below.
5959

6060
## Certify Management Agent
61-
Certify Management Agent is a version of the *Certify Certificate Manager* service which can run "headless" (with no UI) on many different platforms.
61+
[Certify Management Agent](../guides/agent.md) is a version of the *Certify Certificate Manager* service which can run "headless" (with no UI) on many different platforms.
6262

6363
- Docker Hub: https://hub.docker.com/r/certifytheweb/certify-agent
6464
- GitHub Packages: https://github.com/certifytheweb?tab=packages

docs/hub/installation/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ The product runs in Community Edition mode by default, see [Licensing](../../gui
2121

2222
:::danger
2323
Due to the nature of the work the management hub performs we do not recommend hosting on a public facing web server. While logins are required for most actions, the app and API are not considered to be security hardened for public exposure unless we explicitly state that they are. Default admin credentials should be changed immediately after setup.
24-
25-
*This alpha version may have some unguarded API endpoints and is not suitable for public hosting.*
2624
:::
2725

2826
## Upgrading
@@ -35,7 +33,7 @@ The latest release notes for the app can be found at https://certifytheweb.com/h
3533

3634
You can self-host on Windows, macOS or Linux, or you can use your own choice of container environment (Docker, Kubernetes, Red Hat/IBM OpenShift etc).
3735

38-
The product internally uses .NET 9.0 or higher and specific supported operating systems are detailed here: https://github.com/dotnet/core/blob/main/release-notes/9.0/supported-os.md
36+
The product internally uses .NET 9.0 or higher (self contained, you do not need to install .net) and specific supported operating systems are detailed here: https://github.com/dotnet/core/blob/main/release-notes/9.0/supported-os.md
3937

4038
For the web app, "evergreen" desktop web browsers are supported, typically this is Google Chrome, Microsoft Edge, Safari and Firefox.
4139

docs/hub/installation/linux.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ Suggested Configuration for multi-user access:
4949

5050
## Certify Management Agent
5151

52-
The following commands:
52+
[Certify Management Agent](../guides/agent.md) is a version of the *Certify Certificate Manager* service which can run "headless" (with no UI).
53+
5354
- Download the latest version, ensuring any old download and old install files are removed if present
5455
- Extract the downloaded archive to the temporary ./certify-agent-install path
5556
- Runs the install script to install under /opt/certify-agent, and sets up the agent as a systemd service running as user `certify`.
@@ -65,4 +66,6 @@ sudo ./certify-agent-install/scripts/install-agent.sh
6566
To then clean up the temporary install files:
6667
```
6768
rm -rf ./certify-agent*
68-
```
69+
```
70+
71+
By default the agent will install to `/opt/certify-agent` as a systemd service called `certify-agent` with config stored at `/usr/share/certify`.

sidebars.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ export default {
104104
'hub/installation/containers',
105105
'hub/installation/windows',
106106
'hub/installation/linux',
107-
'hub/guides/ccm',
107+
108108
],
109109
},
110+
110111
'hub/guides/request-certificate',
111112
'hub/known-issues'
112113
]
@@ -117,6 +118,14 @@ export default {
117118
items: [
118119
'hub/managedchallenges',
119120
]
121+
},
122+
{
123+
type: 'category',
124+
label: 'Management Agent & CCM',
125+
items: [
126+
'hub/guides/ccm',
127+
'hub/guides/agent',
128+
]
120129
},
121130
{
122131
type: 'category',

src/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You can find out more about our products at https://certifytheweb.com or see bel
3232

3333
</TabItem>
3434
<TabItem value="hub" label="Certify Management Hub" default>
35-
Our new **cross-platform** centralized management hub features a web based UI, all the main features of *Certify Certificate Manager*, plus new features like multi-instance management and managed challenges to help support other ACME clients. **alpha-release for testing**
35+
Our new **cross-platform** centralized management hub features a web based UI, all the main features of *Certify Certificate Manager*, plus new features like multi-instance management and managed challenges to help support other ACME clients.
3636

3737
[Certify Management Hub Documentation](docs/hub/)
3838

0 commit comments

Comments
 (0)