Skip to main content
Version: 0.4.5

Configuration Files

TerrabaseDB supports custom configuration files to let users customize the functioning of TDB. Arguably, TDB has one of the simplest configuration files around.

An example configuration

A configuration file is a TOML file, which looks like:

host = ""
port = 2003
noart = false

enabled = true
every = 120 # Every 120 seconds

This is the default configuration used by TDB when you don't specify a configuration file. Let's understand what each of the keys mean:

  • server :
    • host : This is the IP address to which you want the database server to bind to. It can be any valid IPv4 or IPv6 address, as a quoted string
    • port : This is the port to which you want TDB to bind to
    • noart (OPTIONAL): This is an optional argument and is recommended for secure environments where displaying terminal artwork might cause problems
  • bgsave:
    • enabled : This is an optional key, which is to be set to true to enable BGSAVE or false to disable it. If this key is not specified, TDB will enable BGSAVE by default
    • every : Run BGSAVE every seconds. 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
  • snapshot (OPTIONAL): This key can be used to configure snapshots and is not enabled by default. See this for more information.

Using a configuration file

To use a configuration file:

  1. Create it! We recommend you to name it as tdb.toml for easy identification
  2. Start the database server with: tdb -c /path/to/your/file.toml
  3. Done 🎉

If you're confused about creating a configuration file, we always recommend you to download a sample file from this link. Do note that this file is bleeding-edge and as a result will have new keys as they're created upstream.

That's all that's there for using configuration files!

Bonus tip

If you're using a custom host/port, then you can bind tsh to a custom host/port by starting tsh like:

tsh [HOST] [PORT]