RuleGate Documentation
August 1, 2026 · View on GitHub
The documentation has two connected layers:
- The guide teaches RuleGate from first principles through production in one ordered path.
- Reference documents provide exhaustive contracts, operators, failure behavior, compatibility, and maintainer procedures.
Repository Markdown is the canonical source. The GitHub Wiki edition is built from the guide so the two forms do not drift.
Start with the guide
| Stage | Chapters |
|---|---|
| Learn | Foundations · Packages |
| Build | First API · Policy language · ASP.NET Core |
| Supply trusted data | Attributes and context · Identity and Keycloak |
| Add frontend | Frontend integration |
| Automate | CLI lifecycle · Testing and diagnostics |
| Operate and extend | Policy sources · Extensibility |
| Apply | Real-world recipes · Production checklist |
Use the glossary whenever an authorization term is unfamiliar.
Reference library
| Need | Reference |
|---|---|
| Complete subject/resource/action/context model | Authorization model |
| Every YAML member, operator, type, and validation rule | Manifest reference |
| Minimal API, MVC, imperative, HTTP, and engine integration | ASP.NET Core reference |
| Subject, resource, and context providers | Enrichment reference |
| Modern Angular guards, directives, and generation | Angular reference |
| Angular 9–22 package selection | Frontend compatibility |
| Keycloak backend and frontend mapping | Keycloak reference |
| CLI commands and exit codes | CLI reference |
| Deterministic policy fixtures | Policy testing |
| Decision explanation and manifest linting | Explain and lint |
| Deterministic C# constants | C# generation |
| Local sources and atomic reload | Policy sources |
| Logging and custom sinks | Diagnostics |
| Activities, metrics, benchmarks, and concurrency | Telemetry and performance |
| Full trust and failure boundaries | Security model |
| .NET and Angular support matrix | Platform compatibility |
| Runnable package-consuming applications | Reference applications |
| Preview-to-stable upgrade | Migration to 1.0 |
| Released and planned capabilities | Roadmap |
Published package families
All six NuGet packages and all three npm packages have a stable 1.0.0
release. Use the package selection chapter
for package links, dependency roles, install commands, and framework ranges.
Samples
Maintainer documentation
Maintainer release procedures are intentionally outside the beginner learning path.