> For the complete documentation index, see [llms.txt](https://islamu.gitbook.io/islamu-event/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://islamu.gitbook.io/islamu-event/documentation/readme.md).

# Documentation

Adopter documentation for evaluation, self-hosting, operations, security, and integration.

This space is the operating manual for organizations evaluating or self-hosting ISLAMU Event. It follows the lifecycle of an adoption decision: understand the system, select a topology, configure authoritative state, secure it, operate it, then add product capabilities and integrations.

> \[!WARNING] **Active Pre-Release Development:** ISLAMU Event has **no official release yet**. We are actively fixing startup bugs and preparing for our very first release soon! Pre-built container images and release tags are not yet published.

***

## Recommended Reading Paths

### Evaluator

1. [Getting Started](/islamu-event/documentation/readme/getting-started.md) — Product vision, local quickstart, and architecture.
2. [Self-Hosting](/islamu-event/documentation/readme/self-hosting.md) — Deployment topology selection and capacity planning.
3. [Security & Identity](/islamu-event/documentation/readme/security-and-identity.md) — Authentication, authorization, and GDPR privacy erasure.
4. [Events & Ticketing](/islamu-event/documentation/readme/events-and-ticketing.md) — Event modeling, custom forms, ticketing, and check-in.
5. [Integrations & AI](/islamu-event/documentation/readme/integrations-and-ai.md) — Storage, webhooks, MCP, and external services.

### Self-Hoster & Operator

1. [Self-Hosting](/islamu-event/documentation/readme/self-hosting.md) — Runbooks for Docker Standalone, Docker Compose, and Coolify.
2. [Configuration & Operations](/islamu-event/documentation/readme/configuration-and-operations.md) — Environment variables, secrets, backup, and health checks.
3. [Security & Identity](/islamu-event/documentation/readme/security-and-identity.md) — Keycloak setup and Cerbos vs. Local RBAC.
4. [Administration & Branding](/islamu-event/documentation/readme/administration-and-branding.md) — Web console onboarding, custom domains, and white-labeling.
5. [Communications & Notifications](/islamu-event/documentation/readme/communications-and-notifications.md) — MailKit SMTP outbox and Listmonk subscriber sync.

### Integrator & Contributor

1. [Integrations & AI](/islamu-event/documentation/readme/integrations-and-ai.md) — Outgoing webhooks, Model Context Protocol (MCP), and S3 storage.
2. [Federation & Open Protocols](/islamu-event/documentation/readme/federation-and-open-protocols.md) — AT Protocol federation and custom Lexicons.
3. [Contributing](/islamu-event/documentation/readme/contributing.md) — Local development workflow, Clean Architecture, and TUnit testing.

***

## Documentation Contract

Repository behavior is authoritative. Pages distinguish implemented behavior from deferred or adopter-owned work. They do not claim turnkey cloud deployment, legal or regulatory compliance, religious certification, guaranteed provider behavior, or support for infrastructure the repository does not ship.

The platform uses fail-closed authority boundaries. When identity, authorization, tenant resolution, secrets, privacy erasure, payment evidence, or mandatory public disclosure cannot be established, the system rejects or withholds the operation rather than silently weakening the contract.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://islamu.gitbook.io/islamu-event/documentation/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.