Resources

Everything osctrl, in one place

Documentation, source code, API references and community โ€” your stepping stone into the osctrl and osquery ecosystem.

Documentation

Official docs

๐Ÿ“š

Project documentation

The complete osctrl documentation: concepts, components, deployment guides and usage.

docs.osctrl.net โ†’
๐Ÿงฉ

Components

Deep dives into osctrl-tls, osctrl-api, osctrl-cli and the operator UI.

Components docs โ†’
๐Ÿš€

Deployment

Deploy with Docker or natively with the provisioning script, including production guidance.

Deployment docs โ†’
Code & APIs

For developers & integrators

๐Ÿ’ป

Source code

The osctrl repository on GitHub โ€” Go services, React frontend, deployment configs and tooling. MIT licensed.

jmpsec/osctrl โ†’
๐Ÿ“œ

OpenAPI specification

The full REST API contract for osctrl-api โ€” generate clients or explore endpoints.

osctrl-api.yaml โ†’
๐Ÿ›๏ธ

Architecture notes

The repository's architecture overview and project structure, plus the docs site source.

ARCHITECTURE.md โ†’
๐Ÿ“

Changelog & releases

Release notes, binaries and Docker images for every osctrl version.

Releases โ†’
๐Ÿ›ก๏ธ

Security policy

osctrl is a security-sensitive project โ€” vulnerability reporting and responsible disclosure guidelines.

SECURITY.md โ†’
๐Ÿค

Contributing

Contributions are welcome โ€” fork, open a pull request, or start with an issue for larger changes.

Contributing guide โ†’
Community

Get help & get involved

๐Ÿ’ฌ

Slack

Find us in the #osctrl channel of the official osquery Slack community.

Request an auto-invite โ†’
๐Ÿ›

Issues & discussions

Report bugs, request features or ask questions on the GitHub issue tracker.

GitHub issues โ†’
โญ

Support the project

Star the repository, spread the word, and share how you use osctrl in production.

Star on GitHub โ†’
Ecosystem

osquery resources

osctrl builds on osquery โ€” these references pair well with it.

๐Ÿ”

osquery

The SQL-powered operating system instrumentation framework by the osquery foundation.

osquery.io โ†’
๐Ÿ“–

osquery documentation

Deployment, configuration and the remote API that osctrl implements as its TLS endpoint.

osquery docs โ†’
๐Ÿ—„๏ธ

osquery schema

Browse every table and column available for your queries โ€” osctrl ships schema metadata through 5.23.1.

Schema browser โ†’

Ready to dive in?

Start with the docs, or go straight to a running deployment.