Skip to content

Commit ea3f8df

Browse files
Update docs for management hub and general refactoring
1 parent 6373a91 commit ea3f8df

46 files changed

Lines changed: 3057 additions & 1108 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/nodejs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@ jobs:
1616

1717
strategy:
1818
matrix:
19-
node-version: [20.x]
19+
node-version: [24.x]
2020

2121
steps:
2222
- name: Checkout
23-
uses: actions/checkout@v4
23+
uses: actions/checkout@v6
2424
- name: Use Node.js ${{ matrix.node-version }}
25-
uses: actions/setup-node@v4
25+
uses: actions/setup-node@v6
2626
with:
2727
node-version: ${{ matrix.node-version }}
2828
- run: npm install
2929
- run: npm run build
3030
env:
3131
CI: true
3232
- name: Deploy to GitHub Pages
33-
uses: crazy-max/ghaction-github-pages@v4
33+
uses: crazy-max/ghaction-github-pages@v5
3434
with:
3535
# Allow an empty commit to be created
3636
allow_empty_commit: false

docs/certificate-process.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
22
id: certificate-process
3-
title: Requesting a Certificate
3+
title: Request Your First Certificate
4+
description: Choose domains, validation, deployment options, and renewal behavior when requesting a certificate with Certify Certificate Manager.
45
---
56

7+
Use this guide when you are creating a new managed certificate and want to understand the full request, deployment, and renewal flow.
8+
69
When you install Certify you will be prompted to register with the [Certificate Authority](guides/certificate-authorities.md) who will validate your domains and issue your [certificates](guides/certificates.md) (e.g. Let's Encrypt). You should provide a real email address, otherwise they can't contact you if there is a problem with your certificate.
710

811
:::tip Quick Start

docs/dashboard/index.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
---
2-
title: Using Certify Dashboard
2+
title: Get Started with Certify Dashboard
3+
description: Use Certify Dashboard to monitor certificate renewals across servers, understand reporting sources, and decide when to add Hub or Agent components.
34
---
45

5-
*Certify Dashboard* is our hosted service for monitoring certificate renewals. You can report to the dashboard using [Certify Certificate Manager](/docs/intro), or by using our Certify Management Agent (on linux etc) with supported ACME tools like *Certbot* and *acme.sh*.
6+
# Get Started with Certify Dashboard
7+
8+
*Certify Dashboard* is our hosted service for monitoring certificate renewals across your organization. You can report to the dashboard using [Certify Certificate Manager](/docs/intro) directly, or by using *Certify Management Agent* with supported ACME clients such as *Certbot* and *acme.sh*.
9+
10+
## Best Fit
11+
12+
- You want centralized visibility into renewal success and failure across multiple servers.
13+
- You need a simple hosted monitoring layer without fully centralizing certificate operations.
14+
- You want to see certificate expiry risk and failure details without logging into each server.
615

716
![Dashboard](/assets/screens/dashboard/dashboard_example.png)
817

18+
## Quick Setup
19+
20+
1. If you use *Certify Certificate Manager*, enable dashboard reporting and choose **Add to Dashboard** from the start-up screen.
21+
2. If you use other ACME clients, deploy *Certify Management Agent* and manage that configuration from *Certify Management Hub*.
22+
3. Confirm that renewal activity appears in the dashboard after the next successful request or renewal.
23+
924
## Features
1025
- Monitor successful and failed renewals.
1126
- Receive warnings for items nearing certificate expiration.
@@ -33,4 +48,10 @@ To report to the dashboard from third-party ACME clients, you can use *Certify M
3348
The agent is designed to run on Linux, macOS, or Windows.
3449

3550
## Licensing
36-
*Certify Dashboard* is included with license key purchases for *Certify Certificate Manager*, *Certify Management Hub* and *Certify Management Agent*.
51+
*Certify Dashboard* is included with license key purchases for *Certify Certificate Manager*, *Certify Management Hub* and *Certify Management Agent*.
52+
53+
## Next Docs to Read
54+
55+
- [Certify Management Hub](../hub/)
56+
- [Monitor renewals and alerts](../renewals.md)
57+
- [Get help and support](../support.md)

docs/dns/providers/certifydns.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
11
---
22
id: certifydns
3-
title: Certify DNS
3+
title: Get Started with Certify DNS
4+
description: Use Certify DNS for delegated DNS challenge handling when direct DNS automation is unavailable, and understand setup, troubleshooting, and security tradeoffs.
45
---
56

6-
# Certify DNS
7+
# Get Started with Certify DNS
78

89
*Certify DNS* is an optional service used to answer DNS challenges when your domains normal DNS provider isn't supported for automation. It can be used with any *acme-dns* compatible ACME client. **The service requires a separately purchased *Certify DNS* license and is not bundled with *Certify Certificate Manager***.
910

11+
## Best Fit
12+
13+
- Your DNS provider does not have an API you can automate.
14+
- You need wildcard or DNS-based validation but cannot store primary DNS credentials on every client.
15+
- You want one-time CNAME delegation followed by automated renewals.
16+
17+
## Quick Setup
18+
19+
1. Purchase and activate a *Certify DNS* license.
20+
2. Configure *Certify DNS* credentials in the client that will request certificates.
21+
3. Complete the first request so the service can register each domain.
22+
4. Create the prompted CNAME record in your normal DNS zone.
23+
5. Re-run the request so the certificate authority can follow the delegated challenge.
24+
1025
- The service is a cloud hosted version of the [acme-dns](https://github.com/joohoi/acme-dns) protocol and uses CNAME delegation of acme challenge TXT records to a dedicated challenge response service.
1126
- You can purchase a *Certify DNS* license**, via the https://certifytheweb.com License Keys tab (when signed in). It is not included in other product licenses from us you may already have, e.g. other products like *Certify Certificate Manager* **do not** include a license for *Certify DNS*.
1227
- *Certify DNS* is not required in order to use the Certify Certificate Manager app, it's only required if you specifically want to use DNS challenges and can't use standard DNS automation.
@@ -86,3 +101,8 @@ Disadvantages:
86101
| Cloud Licensed via [Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/webprofusionptyltd1588924351007.certifytheweb-certifydns?tab=Overview) | Monthly | 500 | $4.99 USD |
87102

88103
The standard license can be purchased through your https://certifytheweb.com account on the License Keys tab. The Cloud License option is purchased via your normal Microsoft Azure billing.
104+
105+
## Next Docs to Read
106+
107+
- [DNS validation overview](../validation.md)
108+
- [Get help and support](../../support.md)

0 commit comments

Comments
 (0)