> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.lorenzo0111.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Learn how to configure the plugin

## Scheduler

The scheduler is a task that is automatically scheduled to sync every file every 5 minutes. You can enable and disable it from the configuration file on line 13, the option is named `scheduler`.

## MySQL

The mysql section contains all the data of the database storage. As explained in the configuration, the main server is the one where the files are copied from.

<Note>
  Don't include the port with your host address, you need to adjust it with the port option.
</Note>

Default values are:

```yaml theme={null}
mysql:
  # The main server is the server from the configs are copied
  main: true
  # Database information
  ip: localhost
  port: 3306
  username: "root" #CHANGE THIS TO YOUR DATABASE USER!
  password: "" #CHANGE THIS TO YOUR PASSWORD!
  database: "configsync"
```

## Files

The file section is a list of files to sync. It requires the following schema:

```yaml theme={null}
files:
  Plugin:
    - "file.yml"
```

Replace `Plugin` with the name of the plugin that contains the file that you want to sync.

### Example

For example, if you want to sync the `config.yml` of a plugin called `BedwarsX`:

```yaml theme={null}
files:
  BedwarsX:
    - "config.yml"
```

### Syncing All Files

Add as many files as you want. Instead of the file name you can just put `*` to sync all the files of a plugin.

```yaml theme={null}
files:
  BedwarsX:
    - "*"
```