Документация разделена на две части: одна отвечает на вопрос «как пользоваться», вторая - «как устроено».
user documentation/ - запуск, настройка, работа через веб-интерфейс.
| Документ | Содержание |
|---|---|
| Первый запуск и инициализация | Что спрашивает приложение при старте, создание CA, проверка работоспособности |
| Подготовка к продовой среде | Какие параметры изменить перед эксплуатацией и почему |
| Работа с сертификатами | Разделы интерфейса, типы сертификатов, отзыв и пересоздание |
technical documentation/ - устройство компонентов, схема базы, реализация протоколов.
| Тема | Документ |
|---|---|
| Архитектура, слушатели, порядок запуска | 01-architecture.md |
Разбор config.yaml |
02-configuration.md |
| Таблицы и связи | 03-database.md |
| Криптография, иерархия CA | 04-crypto.md |
| Жизненный цикл сертификатов | 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 и аутентификация | 09-api.md |
| Фоновые чекеры и монитор | 10-checkers.md |
| Веб-интерфейс и шаблоны | 11-web-ui.md |
| Тестовые скрипты | 12-testing.md |
| Вопрос | Где смотреть |
|---|---|
| Как запустить в первый раз | Первый запуск |
| Что поменять перед продом | Продовая среда |
| Почему не выпускаются сертификаты | Не созданы Root и Sub CA - Первый запуск |
| Как проверить, что отзыв работает | Тестирование |
| Какие RFC реализованы | Оглавление техдокументации |