Synthigy documentation

Start

• Getting started — install, first instance, first model, first query
• Glossary — the words these pages use

Concepts

• Modeling data — datasets, entities, attributes, relations, deploying
• The data API — reading and writing over /data, live data
• XSQL — queries as documents, SQL templates

Access

• Access control — users, groups, roles, entity, attribute and row rules
• Sign-in and OAuth — applications, flows, tokens, identity providers
• Signing users in to your app — browser apps and backends, step by step
• Login connectors — checking credentials against your own directory
• Custom login pages — your own sign-in, device, error and status pages
• Browser origins — which web apps may call Synthigy

Operate

• Running Synthigy — instances, services, upgrades, backups, containers
• Portal and console — the portal runs the instance, the console administers it
• Reverse proxy — TLS, client addresses, streaming
• AWS provisioning — a small EC2 server: swap, apt, a service that survives the OOM killer
• Encryption — data keys, master key custody, rotation
• Audit, logs and traffic — history of your data, engine logs
• Troubleshooting — symptoms, causes, fixes

Build

• SDKs — five languages, connecting, code generation
• Embedding — your application and the engine in one jar

Reference

• Environment variables
• CLI