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

# Config file

<details>

<summary>Default config</summary>

### Version 0.0.1-beta

```yaml
version: 1

locale: ru_RU
debug: no

sqlstorage: # SQL Storage settings for every service
  BlockStorage: # Block Storage service for Custom Blocks
    type: sqlite # Only SQLite provided for now
    url: blockstorage.db # SQLite file path
    poolsize: 2 # How much connection keep for use; If sql keep failing use 1 as value
    service: # Service settings
      validate: # Validation settings
        # Validation service is checks every custom block placed in worlds
        # if block is not valid it will try to fix him
        # also very helpful when SQL fail to save data cuz this service
        # will save block again.
        # Validation happens at start, every set period and when server is disabling
        enabled: yes
        period: 300 # In seconds

```

</details>

## Version

Version of the config. Do not change that.

## Locale

The locale that TailsLib should use. All locale files stored in `TailsLib/locale/` folder.

By default after first launch you got 2 languages:

* English (US Version) - `en_US`
* Russian (Русский) - `ru_RU`

To change the language you need to enter name of the file, example:

```yaml
locale: ru_RU # Will change plugin language to russian.
```

If file not presented the default language to set is english. In order to generate languages again just delete the `locale` folder.

## Debug

When enabled will log every useful information.

## SQL Storage

The sql storage service settings AKA database.

If any of system uses SQL then there's sql storage service registered in that section.

Do not change anything if you don't understand what are you doing.

### How this works

```yml
sqlstorage: # <- main category
    BlockStorage: # <- Name of service that need to use sql storage
        type: sqlite # <- type of SQL database to use
        # SQLITE
        url: path_to_file.db # <- How file should be named
        # ANY OTHER
        # still WIP
        service: <- Service settings
            some settings here.
```

### Supported SQL Databases

#### SQLite

**Keyword**: sqlite

**Settings**:

url \[Single string] - Path to file to create or use.


---

# 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://thisistails.gitbook.io/tailslib/user-guide/config-file.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.
