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

# Configuration

{% hint style="warning" %}
You need the `Administrator` permission to setup Katzumi.
{% endhint %}

## Join and leave logs

Start by using the `/setup` command and click on the first option, then click on the button "Start setup", a modal form will appear.

In this form, you'll see a text input named "Logs channel", in it, paste the channel ID of where you want to receive the logs

***

## Welcome and leave messages

Start by using the `/setup` command and click on the second or third option, then click on the button "Start setup", a modal form will appear.

In this form, you'll see a text input named "Arrivals/Leave channel", in it, paste the channel ID of where you want to receive welcome or leave channel.

You can personalize the description of the embed with the variables below !

For partnered and certified servers, you can personalize the title and the image, but you can put the variables below in.

| Variables                                         |
| ------------------------------------------------- |
| `{user.id}` **• Get user id.**                    |
| `{user.username}` **• Get user username.**        |
| `{user.displayname}` **• Get user display name.** |
| `{user}` **• User mention.**                      |
| `{guild.id}` **• Get server id.**                 |
| `{guild.name}` **• Get server name.**             |
| `{guild.count}` **• Get server members count.**   |

***

## DM Messages

> It's a message sent to users when they join servers !

Start by using the `/setup` command and click on the fourth option, then click on the button "Start setup", a modal form will appear.

In this form, you'll see a text input named "Message", in it, write the message you want to be sent !

***

## Bumps

> Bumps is a way to promote your server, when you use the /bump command, the server link is sent to 3 servers that setted an arrival channel !

Start by using the `/setup` command and click on the fifth option, then click on the button "Start setup", a modal form will appear.

In this form, you'll see a text input named "Invite link", in it, paste the invite link to your server, this link will be visible by everyone so choose a good one !\
\
You can also set a description, up to 100 caracters (150 if you have a certified or a partnered server and 200 if you have a community server)

In the last input named "Bumps arrival channel", paste the channel ID of where you want to receive bumps from other servers, you can have some benefits with that !

***

## Join ghost ping

> When someone join your server, the bot will mention the user in a channel and delete the mention after a few seconds, useful for getting someone's attention !

Start by using the `/setup` command and click on the sixth option, then click on the button "Start setup", a modal form will appear.

In this form, you'll see a text input named "Channel", in it, paste the channel ID where you want to mention the user.

{% hint style="info" %}
You can repeat this configuration at any time to change your settings, or use the commands individually as detailed below.
{% 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 dynamically by asking a question.

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

```
GET https://katzumi.gitbook.io/katzumi-docs/guide/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.