> 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/overview.md).

# Overview

### What is CrossBan?

CrossBan is a self-hosted Discord bot that automatically shares ban information between connected servers.\
When a user is banned in one server, the bot can ban them in others, preventing banned users from joining through alternative servers. Unbans can also be synced, but handled a little bit different.

### Key Features

* **Ban Synchronization**: Automatically apply bans across servers.
* **Flexible Modes**: Choose automatic bans or manual review.
* **Logging**: Track unbans and bans in dedicated channels.
* **Truth Sources**: Designate trusted users whose bans are synced.
* **Easy Setup**: Runs in Docker for simple deployment.

### How It Works (High-Level)

1. Admins configure the bot for their servers.
2. When a ban occurs, the bot checks connected servers.
3. Based on settings, it either auto-bans or sends a review message.
4. Unbans are handled similarly, with options for manual approval.

The bot uses a database to store ban records and server settings. It's not a public bot - you host it yourself.

{% hint style="info" %}
If you are interested in getting an understanding of how the bot works under the hood, visit [Under the Hood](/docs/under-the-hood.md).
{% endhint %}


---

# 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/overview.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.