Skip to content

Commit efcca02

Browse files
Add features summary
1 parent 3e21056 commit efcca02

File tree

3 files changed

+220
-1
lines changed

3 files changed

+220
-1
lines changed

docs/features/index.md

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
---
2+
title: Features Overview for all products
3+
description: Comprehensive overview of all features available across Certify The Web products
4+
displayed_sidebar: null
5+
---
6+
7+
# Features Summary
8+
9+
This is a overview of all major features available across the **Certify The Web** product suite, categorized by functionality and indicating which features are common across products or specific to individual components.
10+
11+
## Certificate Management & Automation
12+
13+
### Core Certificate Features
14+
These fundamental certificate management capabilities are available across all products:
15+
16+
- **Automated ACME Certificate Renewals** - Automatic renewal scheduling with configurable timing
17+
- **Multi-CA Support** - Support for Let's Encrypt, Google Trust Services, ZeroSSL, Buypass, and enterprise CAs
18+
- **Certificate Authority Fallback** - Optional automatic fallback to alternative CAs if the primary fails
19+
- **Wildcard Certificate Support** - Full support for wildcard domains (`*.example.com`)
20+
- **IP Certificates** - Certificate covering IPv4 or IPv6 addresses
21+
- **Multi-Domain Certificates (SAN)** - Single certificate covering multiple domains
22+
- **Certificate Preview** - Preview planned changes before requesting certificates
23+
- **Multi-config Validation** - Configure multiple mixed domain/ip validation methods for one certificate
24+
- **Certificate Revocation** - Manual certificate revocation when needed
25+
- **Configuration Export/Import** - Backup and restore certificate configurations
26+
27+
### Advanced Certificate Options
28+
- **Custom Private Key Types** - RSA and ECDSA key support with configurable key sizes
29+
- **Preferred Certificate Chains** - Specify preferred certificate chains for compatibility
30+
- **Certificate Signing Request (CSR) Control** - Optionally use your own CSR, ideal for when the private key is not controlled by you
31+
- **PFX Password Protection** - Secure certificate files with passwords
32+
- **Staging Mode Support** - Test certificates for development and testing
33+
- **Certificate Comments & Metadata** - Organize certificates with custom descriptions
34+
35+
## Domain Validation Methods
36+
37+
### DNS Validation (dns-01)
38+
- **50+ DNS Provider Integrations** - Built-in support for major DNS providers
39+
- **Certify DNS Service** - Hosted acme-dns compatible service
40+
- **acme-dns support** - Standard CNAME-based delegation
41+
- **Manual DNS Option** - Manual TXT record creation when APIs aren't available
42+
- **Custom DNS Scripting** - Custom scripts for unsupported DNS providers
43+
44+
### HTTP Validation (http-01)
45+
- **Built-in HTTP Challenge Server** - Integrated challenge response server
46+
- **IIS Integration** - Automatic HTTP validation via IIS (Windows)
47+
- **Custom HTTP Challenge Handlers** - Configurable challenge response methods
48+
49+
## Deployment & Integration
50+
51+
### Built-in Deployment Tasks
52+
Comprehensive deployment options for various platforms and services:
53+
54+
**Web Servers & Load Balancers:**
55+
- IIS (Auto-deployment with binding management)
56+
- Apache HTTP Server (PEM format export)
57+
- nginx (PEM format export)
58+
- Apache Tomcat (PKCS#12 keystore)
59+
60+
**Microsoft Services:**
61+
- Microsoft Exchange (IMAP, SMTP, IIS, POP services)
62+
- Active Directory Federation Services (ADFS)
63+
- Remote Desktop Services (RDP Gateway, RDP Listener)
64+
- Routing and Remote Access Service (RAS)
65+
- IIS Centralized Certificate Store (CCS)
66+
67+
**Cloud & Container Platforms:**
68+
- Azure App Service
69+
- Azure Key Vault
70+
- HashiCorp Vault (with namespace support)
71+
- AWS services (via export tasks)
72+
73+
**Security & Secrets Management:**
74+
- Local Windows Certificate Store
75+
- Doppler secrets storage
76+
- Various secrets vault integrations
77+
78+
### Custom Deployment Options
79+
- **PowerShell Script Execution** - Custom PowerShell scripts with parameter passing (cross platform)
80+
- **Bash Script Support** - Linux/macOS script execution
81+
- **Webhook Integration** - HTTP webhooks with customizable payloads
82+
- **SSH/SFTP Deployment** - Remote file deployment over secure connections
83+
- **UNC Share Deployment** - Network share certificate distribution (Windows)
84+
- **Service Management** - Start/stop/restart services after deployment (Windows)
85+
- **Permission Management** - Set certificate key permissions (Windows)
86+
87+
## User Interfaces & Management
88+
89+
### Desktop Application (CCM - Windows)
90+
- **Rich Desktop UI** - Full-featured Windows desktop application
91+
- **Real-time Status Monitoring** - Live renewal status and progress tracking
92+
- **Certificate Store Integration** - Direct Windows certificate store management
93+
- **IIS Management** - Visual IIS site and binding management
94+
95+
### Web-Based Management (Management Hub)
96+
- **Cross-Platform Web UI** - Browser-based interface for all platforms
97+
- **Multi-User Access** - Role-based user management and permissions
98+
- **Centralized Management** - Manage certificates across multiple instances
99+
- **API Access** - RESTful API for automation and integration
100+
101+
### Command Line Interface
102+
- **Full CLI Support** - Complete command-line interface for automation
103+
- **Scripting Integration** - PowerShell and bash scripting support
104+
- **Automated Deployment** - Unattended installation and configuration
105+
- **Bulk Operations** - Mass certificate management operations
106+
107+
## Monitoring & Reporting
108+
109+
### Status & Health Monitoring
110+
- **Real-time Status Dashboard** - Live certificate status overview
111+
- **Renewal Failure Detection** - Automatic failure notification system
112+
- **Certificate Expiry Monitoring** - Proactive expiration warnings
113+
- **Detailed Logging** - Comprehensive activity and error logging
114+
115+
### Hosted Dashboard Service
116+
- **Centralized Reporting** - Cloud-based certificate monitoring
117+
- **Multi-Server Aggregation** - Monitor hundreds of servers from one dashboard
118+
- **Failure Analysis** - Detailed failure messages and troubleshooting
119+
- **Email Notifications** - Automated renewal failure notifications
120+
- **Historical Reporting** - Certificate renewal history and trends
121+
122+
### External ACME Client Monitoring
123+
*Hub & Agent Only:*
124+
- **Certbot Integration** - Monitor existing Certbot renewals
125+
- **acme.sh Support** - Track renewals from acme.sh installations
126+
- **win-acme and simple-acme** - Monitor Windows ACME client renewals
127+
- **Posh-ACME Integration** - PowerShell ACME module monitoring
128+
129+
## Infrastructure & Deployment
130+
131+
### Platform Support
132+
**Common Across Products:**
133+
- Windows Server (2016+)
134+
- Windows Desktop (Windows 10+)
135+
136+
**Hub & Agent Only:**
137+
- Linux (Ubuntu, CentOS, RHEL, Debian, Alpine)
138+
- macOS (Intel & Apple Silicon)
139+
- Docker containers
140+
- Kubernetes
141+
- Red Hat/IBM OpenShift
142+
143+
### Data Storage Options
144+
- **SQLite** (Default) - File-based database for single instances
145+
- **Microsoft SQL Server** - Enterprise database support (2016+)
146+
- **PostgreSQL** - Open-source database support (9.5+)
147+
- **Database Migration Tools** - Migrate between database types
148+
149+
### Scalability & Performance
150+
- **Multi-Instance Management** - Manage hundreds of certificate instances
151+
- **Distributed Architecture** - Scale across multiple servers
152+
- **Background Processing** - Non-blocking certificate operations
153+
- **Batch Operations** - Efficient bulk certificate management
154+
155+
## Security & Compliance
156+
157+
### Security Features
158+
- **Encrypted Credential Storage** - DPAPI encryption for stored credentials (Windows)
159+
- **Role-Based Access Control** - Granular user permissions (Hub)
160+
- **API Security** - Token-based authentication for scoped API access
161+
162+
### Compliance & Standards
163+
- **ACME Protocol Compliance** - Comprehensive RFC 8555 ACME support, plus draft features.
164+
- **Industry Standard Formats** - PEM, PFX, PKCS#12 certificate formats
165+
166+
## Specialized Features
167+
168+
### STIR/SHAKEN Certificates
169+
*CCM & Hub:*
170+
- **Telecommunications Certificate Support** - Specialized certificates for telecom providers
171+
- **Authority Token Management** - SPC token and CRL handling
172+
173+
174+
### Import/Export
175+
- **Bulk Certificate Management** - Import/export certificate configurations
176+
- **Migration Tools** - Migrate certificates between instances
177+
- **Backup & Restore** - Complete configuration backup capabilities
178+
179+
## Product-Specific Features
180+
181+
### Certify Certificate Manager (CCM)
182+
- **Desktop UI** - Windows desktop application and background service
183+
184+
### Management Hub
185+
- **Web-Based Interface** - Cross-platform browser access
186+
- **Multi-User Management** - Role-based user accounts
187+
- **Instance Management** - Control multiple CCM instances
188+
- **Container Support** - Docker and Kubernetes deployment
189+
- **Managed DNS Challenges** - Centralized DNS challenge handling
190+
- **Managed ACME API Server** - Act as ACME server for other clients
191+
192+
### Management Agent
193+
- **Headless Operation** - No UI required for Linux/macOS
194+
- **External Client Monitoring** - Monitor third-party ACME clients
195+
- **Cross-Platform Service** - systemd/launchd service integration
196+
197+
### Dashboard Service
198+
- **Hosted Monitoring** - Cloud-based renewal monitoring
199+
200+
---
201+
202+
## Getting Started
203+
204+
To get started with any of these features:
205+
206+
- **Certify Certificate Manager**: [Installation Guide](../guides/installation.md)
207+
- **Management Hub**: [Hub Installation](../hub/installation/index.md)
208+
- **Dashboard Service**: [Dashboard Setup](../dashboard/index.md)
209+
210+
For specific feature documentation, see the individual guides.

docusaurus.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ module.exports = {
2727
{ to: 'docs/hub/', label: 'Management Hub', position: 'left' },
2828
{ to: 'docs/dashboard/', label: 'Dashboard', position: 'left' },
2929
{ to: 'docs/dns/providers/certifydns/', label: 'Certify DNS', position: 'left' },
30+
{
31+
label: 'Features',
32+
to: 'docs/features',
33+
},
3034
{ to: 'docs/support', label: 'Support', position: 'left' },
3135
{ to: 'blog', label: 'Blog', position: 'right' },
3236
{
@@ -59,6 +63,10 @@ module.exports = {
5963
label: 'Certify DNS',
6064
to: 'docs/dns/providers/certifydns',
6165
},
66+
{
67+
label: 'Features',
68+
to: 'docs/features',
69+
},
6270
{
6371
label: 'Support',
6472
to: 'docs/support',

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,11 @@ export default {
248248
collapsed: true,
249249
label: 'Background Information',
250250
items: [
251+
'features/index',
251252
'guides/certificates',
252253
'guides/certificate-authorities',
253254
'http-validation',
254-
'dns/validation'
255+
'dns/validation',
255256
],
256257
},
257258
{

0 commit comments

Comments
 (0)