MyOwnPKI documentation Source on GitHub

Reference

The guides on this site are written for tasks. This is the material you look things up in. Three of the pages are the files of the repository, shown unchanged: when a file changes on main, the page is built again.

Page What it is Source in the repository
Operations guide The operator’s book: what runs where, install, init, running, backup and restore, passphrase and recovery key, when something is lost, upgrading, the ACME server, the trust page, the agent, monitoring, the TLS scan, reports and analysis docs/OPERATIONS.md
Configuration file Every key of config.yaml with its default and a comment deploy/config.example.yaml
Command line The commands of myownpki and myownpki-agent cmd/
REST API How to call the API, how to make a token, what a token cannot do api/openapi.yaml
Release notes What changed in every release, with the upgrade notes CHANGELOG.md
Security What protects what, how to report a vulnerability, how to verify a download SECURITY.md, docs/PLAN.md
Contributing How to change the code or these pages CONTRIBUTING.md

The operations guide by chapter

  1. What runs and where: listeners, files and the secrets of init
  2. Install and configure: install.sh, containers, settings, certificates the server issues itself
  3. First start: init
  4. Running the server: seal, health checks, logs, the audit log
  5. Moving from pki.sh
  6. Backup and restore, with the daily timer
  7. Passphrase and recovery key
  8. When something is lost or wrong
  9. Upgrading
  10. ACME server: proxies, domains, EAB keys, clients, split DNS, errors
  11. The public trust page
  12. Agent: server setup, installation, agent.yaml, firewall, status
  13. Monitoring and notifications
  14. TLS scan
  15. Reports and analysis: charts, the ten analysis rules, who sees them, the API

More in the repository