Skip to content

Guides

Each guide covers one part of quinectl.yaml or one way of working with quinectl. Read Configure quinectl first, because it explains the file most of the other guides change. After that, read them in any order, picking each by what you want to add or change.

Set up what runs

Guide What it covers
Configure quinectl How quinectl.yaml is laid out, the required choices, and how changes take effect
Passing Settings Through Product options quinectl has no field for: configFile, properties, jvmProperties
Auth and RBAC with Keycloak Keycloak roles, sample users, bearer tokens, and trusting the local certificate
Run Novelty Novelty on its own or beside Quine Enterprise
Run a Local Cluster Several Quine Enterprise members plus hot spares on one machine
Graph Storage Cassandra, RocksDB or in-memory, and resetting the data
Kafka A local broker, topics seeded from files, and ingesting them
Metrics Prometheus and Grafana with thatDot's dashboards

Reach the products

Guide What it covers
Reverse Proxy nginx in front of a product, optionally with HTTPS
Local Hostnames Names such as quine.localhost in place of localhost, with publicUrl
Deploy to EC2 A shared demo on one EC2 instance behind a load balancer

Share a machine

Guide What it covers
Multi-tenancy Several projects on shared Cassandra, Keycloak and Kafka, each with its own graph and users

Automate

Guide What it covers
Scripting and CI Background launch, JSON output, exit codes, and prompts that never hang
Using quinectl from AI Agents The built-in agent guide and separate project settings
Shell Completion Tab completion in bash, zsh, fish and PowerShell