Skip to content

FAQ

  • Getting started

    What Scribe does and which APIs are available.

  • Access problems

    Why an API is hidden or a request fails.

  • Investigation

    How to obtain more diagnostic information.

Choose a question and follow its short answer to the detailed guide.

Find a direct answer below, then follow its guide when you need the full procedure.

Next: Troubleshooting

Quick answers. For full details, follow the links.

Scribe syncs LDAP directories to PostgreSQL and serves queries through LDAP, REST, GraphQL, and MCP channels. Every change is appended to the entry history. See Architecture.

LDAP, REST, and GraphQL are stable. MCP is experimental and gRPC is on the roadmap. See Channels for details and examples.

By default IdentityScribe runs in production mode, which hides the interactive API documentation at /api. Your data routes under /api/entries/... and the Operator UI keep working. See API Access & Networking — Production API documentation.

The REST channel is off by default. Set channels.rest.enabled = true (or SCRIBE_REST_ENABLED=true) and restart. See API Access & Networking — Enable REST data routes.

Check the ingest stats at /observe/stats/ingest. See Monitoring.

Add a new block under transcribes {} in your config file. Each transcribe syncs one entry type. See Transcribes configuration.

Update the environment variables (LDAP_BIND_PASSWORD, DB_PASSWORD, etc.) and restart. Scribe reads secrets from env vars at startup. See Production Checklist.

Scribe runs database migrations automatically on startup. See Upgrading for version-specific migration notes and breaking changes.

Enable debug logging with SCRIBE_LOG_LEVEL=debug, check the doctor endpoint at /observe/doctor, or inspect traces. See Logging and Traces for the full investigation workflow.