> For the complete documentation index, see [llms.txt](https://docs.jonesdev.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jonesdev.xyz/administration/configuring-sonar/setting-up-a-database.md).

# Setting up a database

{% hint style="info" %}
IP addresses are stored in plain text, so ensure your database is secure.
{% endhint %}

Defines the type of database used by Sonar. Options include `NONE`, `MYSQL`, `MARIADB`, `POSTGRESQL`, and `H2` (recommended). Default: `NONE`

```yaml
type: NONE
```

Specifies the file name for the `H2` database stored in Sonar's plugin directory. Default: `verified_players`

```yaml
filename: verified_players
```

The host address for SQL database authentication. Default: `localhost`

```yaml
host: localhost
```

The port number for SQL database authentication. Default: `3306`

```yaml
port: 3306
```

The name of the SQL database. Default: `sonar`

```yaml
name: sonar
```

The username and password are used by Sonar to authenticate the connection to the database. The connection will fail if no username or password are given.

```yaml
username: 'my_username'
```

```yaml
password: 'my_p@ssw0rd!'
```

The number of days Sonar should retain verified players in the database. Default: `5`

```yaml
maximum-age: 5
```


---

# 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://docs.jonesdev.xyz/administration/configuring-sonar/setting-up-a-database.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.