The documentation is split in two parts: one answers "how to use it", the other one "how it works inside".
user documentation/ - startup, configuration and day-to-day work through the web interface.
| Document | Contents |
|---|---|
| First run and initialization | What the application asks on startup, creating the CA, verifying that everything works |
| Preparing for production | Which parameters to change before going live and why |
| Working with certificates | Interface sections, certificate types, revocation and reissuance |
technical documentation/ - component design, database schema, protocol implementation.
| Topic | Document |
|---|---|
| Architecture, listeners, startup order | 01-architecture.md |
Breakdown of config.yaml |
02-configuration.md |
| Tables and relations | 03-database.md |
| Cryptography, CA hierarchy | 04-crypto.md |
| Certificate lifecycle | 05-certificates.md |
| CRL - RFC 5280 | 06-crl.md |
| OCSP - RFC 6960, RFC 5019 | 07-ocsp.md |
| EST - RFC 7030 | 08-est.md |
| REST API and authentication | 09-api.md |
| Background checkers and monitor | 10-checkers.md |
| Web interface and templates | 11-web-ui.md |
| Test scripts | 12-testing.md |
| Question | Where to look |
|---|---|
| How do I start it the first time | First run |
| What to change before production | Production setup |
| Why can't I issue certificates | Root and Sub CA are not created yet - First run |
| How do I verify revocation works | Testing |
| Which RFCs are implemented | Technical documentation index |