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 SectionReefLogic 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 ManualReefLogic User Manual
Follow practical guidance for using ReefLogic workflows and operating tasks after installation.
Open User ManualReefLogic API for Developers
Explore protobuf and gRPC contracts for integrations. Includes links to shared C++ commons APIs.
Open API ReferenceFAQ
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.