Source of docs.openctem.io, the documentation for OpenCTEM, the open-source Continuous Threat Exposure Management platform.
The site is built with Jekyll and the
Just the Docs theme and published by GitHub Pages from
main (.github/workflows/pages.yml).
| Directory | Section |
|---|---|
overview/ |
What OpenCTEM is, architecture, concepts, glossary |
install/ |
Requirements, Docker Compose, all-in-one image, Kubernetes, TLS |
configuration/ |
Environment variables reference, email, notifications |
operations/ |
Upgrades, versioning, backups, monitoring, scaling, troubleshooting, logs |
console/ |
The platform console for platform administrators |
security/ |
Security model, hardening, vulnerability disclosure, data handling |
identity/ |
SSO, SCIM, sign-up, roles and permissions, two-factor authentication |
sensors/ |
Deploying and pairing sensors, scan zones, network requirements |
scanning/ |
Scope, scan workflows, scans and runs, tools, CI integration |
user-guide/ |
Using the web console |
api/ |
REST API, authentication, conventions, webhooks, MCP, ingest |
developers/ |
Local setup, contributing, testing, migrations, releases, writing a tool |
legal/ |
Licenses, privacy policy, terms |
Engineering documents that change with the code (architecture notes, RFCs, versioned
upgrade guides) live next to the code in
openctemio/openctem api/docs;
the site links to them.
docker run --rm -it -p 4000:4000 -v "$PWD":/site -w /site ruby:3.3 \
bash -c "bundle install && bundle exec jekyll serve --host 0.0.0.0"Then open http://localhost:4000.
The console screenshots in assets/images/<section>/ come from a scratch installation
filled with the fictional organization Example Corp, and are regenerated for each
release:
-
Start a scratch stack (API, web console, PostgreSQL, Redis) from the openctem release, with an empty database. Never use a real installation.
-
Seed it: see scripts/demo-seed/README.md.
-
Capture (headless Chromium, 1440×900):
cd scripts npm install && npx playwright install chromium OPENCTEM_WEB_URL=http://localhost:3000 OPENCTEM_API_URL=http://127.0.0.1:8080 \ npx tsx capture-screenshots.ts # or a filter: capture-screenshots.ts 'scanning/'
The script signs in as the demo accounts, blurs anything that looks like a credential, and writes palette PNGs (WebP above 300 KB). Review every image before committing it.
Open a pull request against main. Write in English, check every command, flag and
setting against the code, use example.com hosts and documentation IP ranges
(192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24) in examples, and keep links
relative. The docs-check workflow runs a link check and rejects non-English text and
private addresses.
Report security vulnerabilities to security@openctem.io, not in issues. Other questions: info@openctem.io.