Running Tentris with Binaries

Tentris runs directly on any modern Linux distribution or ARM macOS (M1 chip or newer) via its command-line binaries.

The instructions provided below and in the following sections and chapters demonstrate the capabilities of Tentris and assume that Tentris is installed in the user's system.

Installing Tentris

Install Tentris.

curl --proto https --tlsv1.2 -sSf https://raw.githubusercontent.com/tentris/tentris/refs/heads/main/install.sh | sh

Ensure that Tentris is installed.

tentris --version

To get detailed information about commands provided by Tentris use the --help option.

tentris --help

The option --help is also available for each subcommand (e.g., load).

tentris load --help

Top Level Options

The top-level options that modify the core behavior of Tentris are detailed below and are applicable to all subcommands provided by Tentris (e.g., load and serve).

Note: These options need to appear before the subcommand name:
tentris --config myconfig.toml load and not tentris load --config myconfig.toml.

• --license <LICENSE>
  Specifies a custom path to the tentris license file. If --license is not used, Tentris will check the config file for a license path. If that path is also not set, it will look in the following locations.

  1. ./tentris-license.toml (working directory)
  2. ~/.config/tentris-license.toml (home config directory)
  3. /etc/tentris-license.toml (global config directory)

• --config <CONFIG>
  Specifies a custom path to the tentris-server-config.toml file. If --config is not used, Tentris will search for the configuration file in specific locations using the following order.

  1. ./tentris-server-config.toml (working directory)
  2. ~/.config/tentris-server-config.toml (home config directory)
  3. /etc/tentris-server-config.toml (global config directory)

  If no config file is found, Tentris uses its default settings, which are detailed in the chapter Configuration File.

• -s, --datastore-path <DATASTORE_PATH>
  Sets the path for the persistent data storage. This command-line option overrides the path specified in the configuration file. The dafault location for the datastore is ./tentris_data.

• --log-level <LOG_LEVEL>
  Adjusts the verbosity of the log output. The available options are error, warn, info, debug, and trace.

• --log-output-format <LOG_OUTPUT_FORMAT>
  Determines the format of the log messages. The available options are default (log format) and json. This command-line option overrides the format specified in the configuration file.

• --color <COLOR>
  Manages color in the log output. The available options are auto, always, and never. The default value is auto.

• --no-debug-logging
  Disables writing to the detailed debug log file that is maintained by default. The log message is placed in the working directory (./tentris-debug-log.json).