Configuration Files

    A configuration file is a TOML file, which has the following basic structure:

    Let’s understand what each of the keys mean along with some other keys that can be used for more advanced configuration:

    • (required):
      • port: This is the port to which you want Sky to bind to
      • noart (optional): This is recommended for secure environments where displaying terminal artwork might cause problems
      • maxcon (optional): Set the maximum number of clients that can query concurrently
      • mode (optional): Should be set to for production deployments and dev during development
    • bgsave (optional):
      • every: Run BGSAVE everyseconds. So, for example, if you set this to 120, BGSAVE will run every two minutes. This is also an optional key, and if you don’t provide it, the default BGSAVE duration of 120 seconds is used
    • (optional): This key can be used to configure snapshots and is not enabled by default. See for more information.
    • ssl (optional): This key can be used to configure SSL/TLS options. See this for more information.
    1. Create it! We recommend you to name it as skyd.tomlfor easy identification
    2. Start the database server with: skyd -c /path/to/your/file.toml

    If you’re confused about creating a configuration file, we always recommend you to download the template configuration from .

    That’s all that’s there to using configuration files!

    Bonus tip

    You can do the same for :

    The official Docker image will look for a configuration file at /etc/skytable/skyd.toml within the container. To use a file on the host as the configuration file in the container, we’ll make use of Docker volumes. Simply follow the and then start your docker image like this: