> For the complete documentation index, see [llms.txt](https://crossban.thelukez.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://crossban.thelukez.com/de/dokumentation/installation-and-setup.md).

# Installation und Einrichtung

### Voraussetzungen

* Ein Computer oder Server mit installiertem Docker und Docker Compose.
* Ein Discord-Bot-Token (erstelle eines im [Discord Developer Portal](https://discord.com/developers/applications)).
* PostgreSQL-Datenbankzugriff (wird über Docker verwaltet).

### Schritt-für-Schritt-Einrichtung

1. **Repository klonen**:

   ```bash
   git clone https://github.com/The-LukeZ/CrossBan.git
   cd CrossBan
   ```
2. **Umgebungsdatei vorbereiten**:
   * Beispiel kopieren: `cp .env.example .env`
   * Bearbeite .env mit deinen Angaben.
3. **Bot starten**:

   ```bash
   pnpm docker:build  # führe dies nur einmal aus, sonst gehen Daten verloren
   pnpm docker:start  # nutze dies, sobald du den Container gebaut hast
   ```

   * Dies baut und führt die App in Containern aus.
4. **Bot einladen**:
   * Verwende das Discord-Entwicklerportal, um einen Einladungslink mit Berechtigungen zum Verwalten von Banns und Nachrichten zu erstellen und vor allem zum Anzeigen der Audit-Logs.
5. **Verifizieren**:
   * Der Bot sollte in deinen Servern online erscheinen. Führe config aus, um mit der Konfiguration zu beginnen.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://crossban.thelukez.com/de/dokumentation/installation-and-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
