Skip to content

ReefLogic User Documentation

Welcome to the ReefLogic documentation portal. Choose the path that matches your goal.

This documentation is organised for operations teams, platform administrators, end users, and developers. Start with Deployment if you are installing ReefLogic on your own server. Move on to the Administration Manual to operate the admin desktop client and manage tenants, roles, and identity providers. Continue with the User Manual for day-to-day data and survey workflows, and consult the API Reference when integrating services.

Deployment

Install and run ReefLogic on your own infrastructure, including prerequisites and rollout checks.

Open Deployment Section

ReefLogic Administration Manual

Operate the ReefLogic admin desktop client: connect to a server, bootstrap a fresh deployment, manage tenants, roles, permissions, grants, and OIDC identity providers.

Open Administration Manual

ReefLogic User Manual

Follow practical guidance for using ReefLogic workflows and operating tasks after installation.

Open User Manual

ReefLogic API for Developers

Explore protobuf and gRPC contracts for integrations. Includes links to shared C++ commons APIs.

Open API Reference

System Overview

Backend — hosted or self-managed

ReefLogic is built around a server backend (PostgreSQL with PostGIS, an OIDC identity provider, and the ReefLogic admin server) that can either be self-managed on your own infrastructure or run as a hosted backend operated for you. The self-hosted path is documented end-to-end in the Deployment section, including the Docker Compose appliance, host HAProxy TLS termination, and the Keycloak realm import. A managed-hosting option is on the roadmap and will be linked here once available.

Authentication and authorization

Operators sign in over OIDC PKCE against Keycloak (for platform administrators) or a per-tenant identity provider (for tenant operators). The IdP issues a JWT whose groups claim — default name urn:reeflogic:roles — lists the operator's group memberships. The admin server resolves each group to a ReefLogic role, and the role's grants (permission × CRUDX mask) are checked on every gRPC call. Group-to-role mapping is the central authorization knob. See OIDC settings, Roles, Permissions, and Grants.

Server administration — system and tenants

The admin desktop client talks to the admin server over gRPC after OIDC PKCE login. Platform administrators use it to bootstrap a fresh deployment, register tenants and their per-tenant OIDC providers, and maintain roles, permissions, and grants both at platform scope and inside each tenant namespace. Full screen-by-screen guidance lives in the Administration Manual, in particular Tenants.

End-user client and synchronization service

The end-user ReefLogic client and the synchronization service are not yet generally available. When released they will provide offline-capable data and survey workflows on Linux, Windows, and macOS, kept in sync with the backend through the sync service. The User Manual will grow to cover these workflows as they ship.

FAQ

Where do I start when self-hosting ReefLogic?

Start with the Deployment section for server-side installation and setup. Once the stack is running, the Administration Manual walks you through bootstrapping the server from the admin desktop client.

How do I manage tenants, roles, and operator identities?

Use the ReefLogic Administration Manual. It documents every screen of the admin desktop client — connection profiles, OIDC PKCE login, the initial-setup wizard, OIDC settings, roles, permissions, grants, and tenants.

Where is the operational user guide?

Use the ReefLogic User Manual for day-to-day data and survey workflows once your administrator has provisioned your tenant and roles.

Where are integration contracts and API details?

Use ReefLogic API for Developers for gRPC/protobuf contracts and shared interface references.