Skip to content

Commit f1267d5

Browse files
Docs updates, sidebar changes
1 parent 15b1b9c commit f1267d5

File tree

7 files changed

+50
-44
lines changed

7 files changed

+50
-44
lines changed

docs/dns/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: validation
3-
title: DNS Validation (dns-01)
3+
title: DNS Domain Validation (dns-01)
44
---
55

66
## Why use DNS Validation?

docs/guides/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ The app runs in Community Edition mode by default, see [Licensing](licensing.md)
3131

3232
By default the app will check for updates when you open the UI. If you do not regularly open the UI, it's worth checking for updates periodically. Some updates are critical to ensure continuous operation, and only the latest version is supported.
3333

34+
To upgrade manually you can download the latest version and install it. You don't normally need to uninstall first etc.
35+
3436
The latest release notes for the app can be found at https://certifytheweb.com/home/changelog
3537

3638
### Settings are preserved between installs/upgrades

docs/http-validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: http-validation
3-
title: HTTP Validation (http-01)
3+
title: HTTP Domain Validation (http-01)
44
---
55
## Why use HTTP Validation?
66
To request a certificate from Let's Encrypt (or any Certificate Authority), you need to provide some kind of proof that you are entitled to receive the certificate for given domain(s). Let's Encrypt support two methods of validation to prove control of your domain, `http-01` (validation over HTTP) and `dns-01` ([validation via DNS](dns/validation.md)). Wildcard domain certificates (those covering `*.yourdomain.com`) can only be requested using DNS validation.

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: intro
33
title: Getting Started
44
---
55

6-
# Introduction
6+
# Getting Started
77

88
[Certify The Web](https://certifytheweb.com) - *Certify Certificate Manager* is the most popular UI for professional ACME certificate management on Windows, allowing you to easily request, deploy, auto-renew and manage free SSL/TLS [certificates](guides/certificates.md) from Certificate Authorities such as **[Let's Encrypt, BuyPass Go, Google Trust Services, ZeroSSL and custom CAs](guides/certificate-authorities.md)**.
99

docs/renewals.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,24 @@ All certificates have an expiry date, after which they cannot be used to secure
77

88
**By default, Certify will attempt to auto-renew your certificates and tell you if something goes wrong**
99

10-
The app includes a Certify background service which performs all the main function for managed certificates, so you don't need to leave the UI open for renewals etc to run. If the renewal process fails repeatedly, **it will try to notify you** via our API before certificate expiration becomes a problem, unless you have disabled the *Enable Status Reports to Dashboard* option under Settings. **Ensure that your 'Certificate Authority Account' under Settings > Certificate Authorities is set to a real, monitored, email address** preferably accessible by others if you are a group of site administrators. You do not need to configure anything else like SMTP relays etc. to use this feature, it's all automatic by default.
10+
The renewal frequency defaults to 75% of the certificate lifetime. This is configurable under Settings in the app.
1111

12-
In addition, as your certificate approaches expiration, the certificate authority (such as Let's Encrypt) may also email you. This can also happen if you have changed a certificate (for instance to add more domains to it) so you may get emails for expiring certificates you have since replaced.
12+
The app includes a Certify background service which performs all the main function for managed certificates, so you don't need to leave the UI open for renewals etc to run.
13+
14+
## Monitoring Certificate Renewals
15+
16+
### Zero Config Status Reporting API
17+
Unlike almost all other ACME clients, if the renewal process fails repeatedly, **the app API will try to notify you** via our API before certificate expiration becomes a problem, without any special configuration from yourself, unless you have disabled the *Enable Status Reports to Dashboard* option under Settings. **Ensure that your 'Certificate Authority Account' under Settings > Certificate Authorities is set to a real, monitored, email address** preferably accessible by others if you are a group of site administrators. You do not need to configure anything else like SMTP relays etc. to use this feature, it's all automatic by default.
18+
19+
In addition, as your certificate approaches expiration, the certificate authority (such as Let's Encrypt) *may* also email you. This can also happen if you have changed a certificate (for instance to add more domains to it) so you may get emails for expiring certificates you have since replaced.
20+
21+
### Certify Dashboard
22+
You can optionally send reports to the certifytheweb.com [Dashboard](dashboard/index.md) when a renewal is successful or fails. This is useful if you have multiple system administrators and want to see when a renewal fails, or if you want to monitor renewal attempt status across many servers. You can see the status of all your certificates on the dashboard. To get started with sending reports to the Dashboard, select the *Add to Dashboard* option from the start up screen of the app on your machine.
1323

1424
## App Updates Are Important
1525

1626
If the app offers an update you should check the release notes to see if they sounds relevant to you and if in doubt you should update the app anyway. Certificate Authorities regularly change how their services work, and not updating the app can result in future renewal failures. We only support the latest version of the app at all times.
1727

18-
## Dashboard
19-
You can optionally send reports to the https://certifytheweb.com dashboard when a renewal is successful or fails. This is useful if you have multiple administrators and want to be notified when a renewal fails. You can also see the status of all your certificates on the dashboard. To get started with sending reports to the Dashboard, select the *Add to Dashboard* option from the start up screen of the app on your machine.
20-
2128
## Certificate Cleanup
2229

2330
By default the app will remove certificates it has created (which have `[Certify]` in the 'friendly name') once they have been expired for over a month. This is to allow users who have manually allocated the certificate to other services to switch to the latest certificate before we delete the old one.

docs/support.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,24 @@ To get started using the Certify The Web, see the [Getting Started Guide](intro.
99

1010
Check out our [FAQ](faq.md) if you are just getting started and having trouble with something.
1111

12-
If you'd just like to ask general questions or help others get started, check out our community forum: <a href="https://community.certifytheweb.com" target="_blank">community.certifytheweb.com</a>
13-
14-
If there is a general bug or feature request you'd like to discuss in public, you can create a new issue against our <a href="https://github.com/webprofusion/certify/issues" target="_blank">GitHub project</a>
15-
1612
## Commercial Support
1713

1814
**The application is ideal for organisations or professionals who need a tool with dependable support.**
1915

2016
_You are encouraged to test out the software yourself as an evaluation before purchasing as not all usage scenarios will be supported._
2117

22-
Full time support is available via email support tickets for registered users (or those who are evaluating the software). You can register for the Professional or Enterprise editions via https://certifytheweb.com/upgrade/.
18+
Full time support is available via email support tickets for registered users (or those who are evaluating the software). You can register for the Professional or Enterprise editions via https://certifytheweb.com/upgrade/. To create a new support request for help or for general questions, email **support at certifytheweb.com**, including details of your licensed email address, describing the problem/question in detail with any supporting information you can provide.
19+
20+
- Please include how to recreate the problem and any special configuration you may have.
21+
- Logs for managed certificates can be found on the Status tab of each managed certificate.
22+
- Domain details shared with us via support are treated as confidential and there is no need to redact domains in logs etc (redacting domains can make issue diagnosis more difficult).
2323

2424
Support operates weekdays (Australian Western Standard Time) with some coverage on weekends. Telephone support and general consultancy is not currently available but we will try to help where we can for all questions.
2525

26-
Users of the free Community Edition are also supported via our community forum and github issues.
26+
## Community Support
27+
All users of the free Community Edition are encouraged to join our community forum: <a href="https://community.certifytheweb.com" target="_blank">community.certifytheweb.com</a>
28+
29+
If there is a general bug or feature request you'd like to discuss in public, you can create a new issue against our <a href="https://github.com/webprofusion/certify/issues" target="_blank">GitHub project</a> or discuss on the community forum.
30+
2731

28-
To create a new support request for help or for general questions, email **support at certifytheweb.com**, including details of your licensed email address, describing the problem/question in detail with any supporting information you can provide.
2932

30-
Please include how to recreate the problem and any special configuration you may have. Logs for managed certificates can be found on the Status tab of each managed certificate. Domain details shared with us via support are treated as confidential and there is no need to redact domains in logs etc (redacting domains can make issue diagnosing more difficult).

sidebars.js

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,40 @@ export default {
66
type: 'category',
77
label: 'Introduction',
88
items: [
9-
"intro",
10-
"guides/installation",
11-
"certificate-process",
12-
"renewals"
9+
'intro',
10+
'guides/installation',
11+
'certificate-process',
12+
'renewals'
1313
]
1414
},
1515
{
1616
type: 'category',
1717
label: 'Guides',
1818
items: [
19-
2019
{
2120
type: 'category',
2221
collapsible: true,
22+
collapsed: true,
2323
label: 'Background Information',
2424
items: [
25-
"guides/certificate-authorities",
26-
"guides/certificates",
27-
"http-validation",
28-
"dns/validation"
25+
'guides/certificates',
26+
'guides/certificate-authorities',
27+
'http-validation',
28+
'dns/validation',
29+
'guides/best-practices',
30+
'backgroundservice',
31+
'guides/ssl-windows',
32+
'guides/troubleshooting'
2933
],
3034
},
3135
{
3236
type: 'category',
3337
collapsible: true,
38+
collapsed: true,
3439
label: 'Advanced Deployment',
3540
items: [
36-
"deployment/tasks_intro",
37-
"script-hooks",
41+
'deployment/tasks_intro',
42+
'script-hooks',
3843
{
3944
type: 'doc',
4045
id: 'guides/apache-nginx',
@@ -48,34 +53,24 @@ export default {
4853
{
4954
type: 'category',
5055
collapsible: true,
56+
collapsed: true,
5157
label: 'Other Advanced Options',
5258
items: [
53-
"features/certificate-advanced",
54-
"commandline",
55-
"csv-import",
59+
'features/certificate-advanced',
60+
'commandline',
61+
'csv-import',
5662
'features/stir-shaken'
5763
]
5864
},
5965
]
6066
},
61-
{
62-
type: 'category',
63-
label: 'Useful Info',
64-
items: [
65-
"guides/best-practices",
66-
"guides/ssl-windows",
67-
"backgroundservice",
68-
'guides/troubleshooting'
69-
70-
]
71-
},
7267
{
7368
type: 'category',
7469
label: 'Support',
7570
items: [
76-
"guides/licensing",
77-
"faq",
78-
"support"
71+
'guides/licensing',
72+
'faq',
73+
'support'
7974

8075
]
8176
}

0 commit comments

Comments
 (0)