Skip to content
Zuthree Docs Zuthree Docs Zuthree Docs

CLI

zuthree start

This is the default command used to initiate the Zuthree Manager application.

In typical deployments, Zuthree Manager is managed as a system service, and the start command is not typically invoked directly. However, you can use the start command to manually launch additional instances of Zuthree Manager for testing purposes.

Flags

The command accepts common flags.

zuthree save-config

This command allows you to save the current configuration settings to a file. This eliminates the need to repeatedly provide command-line arguments or environment variables when starting Zuthree Manager.

Flags

The command accepts common flags.

zuthree update-license

This command provides a convenient way to update the license file for Zuthree Manager from the command line, eliminating the need for manual file updates.

Flags

TODO

Common Flags

--tftpPort

Shorthand argument: t
Type: number
Default value: 69
Required: no

Defines the port used by the TFTP server of Zuthree Manager.

It is generally recommended to use the default TFTP port (69/UDP). Changing this port is typically not necessary and may cause compatibility issues with your phones.

Modifying the TFTP port may be required in specific scenarios, such as:

  • Running multiple instances of Zuthree Manager on the same server.
  • Testing or troubleshooting configuration.

--httpPort

Shorthand argument: p
Type: number
Default value: 3000
Required: no

Defines the port used by the HTTP server component of Zuthree Manager. Your web browser will use this port to access the Zuthree Manager application.

If you are not using a reverse proxy server (such as Nginx), it is recommended to use the default HTTP port (80). Using a reverse proxy server is generally recommended for enhanced security, load balancing, and other advanced features.

--serverAccessibleName

Shorthand argument: h
Type: string
Required: yes
Example values: zuthree.internal.yourcompany.com, 192.168.0.20:3000

Defines the network name or address of the server running Zuthree Manager.

This information is used by other applications running on the phone to locate and retrieve additional resources, such as XML apps.

The Server Network Name should include both the hostname or IP address of the server and the port number.

If you are using a reverse proxy server, the format should be compatible with how your reverse proxy resolves and forwards requests to Zuthree Manager.

--storage or --storageFolder

Shorthand argument: s
Type: string
Default value: \opt\.zuthree\storage
Required: no

Defines the location for storing application files.

All files used by the TFTP server, along with the database and logs, are stored within this directory.

You can use either a relative path (relative to the Zuthree Manager installation directory) or an absolute path.

--output

Shorthand argument: o
Type: string
Possible values: pretty, json, logstash
Default value: pretty
Required: no

Controls how application logs are generated and output.

  • pretty: generates human-readable log messages, making them easy to understand for human operators.
  • json: outputs logs in the JSON format. This structured format is ideal for machine parsing and analysis, enabling easier integration with log management and monitoring tools.
  • logstash: a specialized format designed for seamless integration with the Logstash data collection pipeline, facilitating advanced log processing and analysis.

--noLogFiles

Type: boolean
Default value: false
Required: no

Controls whether Zuthree Manager should store logs locally, in addition to the system journal.

By default, Zuthree Manager stores its logs from the last 7 days in the storage folder in addition to the system journal.

--config

Shorthand argument: c
Type: string
Default value: /root/.zuthree/config.json
Required: no

Allows to specify a custom path to a configuration file. This is useful for managing multiple Zuthree Manager instances with different configurations (e.g. for testing or development).

Changing this path requires to manually update the systemd service file to reflect the new location.

--databaseType or --db

Shorthand argument: d
Type: string
Possible values: sqlite, postgres
Default value: sqlite
Required: no

Determines the type of database used by Zuthree Manager to store application data.

  • SQLite: utilizes an embedded SQLite database, stored as a single file within the Zuthree Manager storage folder. This option is suitable for smaller deployments and simpler setups.
  • PostgreSQL: allows the use of an external PostgreSQL database server. This provides greater scalability, flexibility, and advanced features such as high availability and advanced security.

Using PostgreSQL requires configuring additional parameters, such as database connection details (--databaseHost, port, --databaseUser, password).

--databaseHost or --dbh

Type: string
Required: yes for postgres database, no for sqlite database

Specifies the hostname or IP address of the PostgreSQL database server.

--databasePassword or --dbpw

Type: string
Default value: ZUTHREE_DATABASE_PASSWORD environment variable
Required: yes for start command, no (and not recommended) for save-config command

Defines the password for the internal SQLite database used by Zuthree Manager. This password protects your sensitive data stored within the database.

Do not use this option with the save-config command. Storing the database password directly in the configuration file poses a significant security risk.

For enhanced security, use the ZUTHREE_DATABASE_PASSWORD environment variable to securely provide the database password.

--databaseUser or --dbu

Type: string
Required: yes for postgres database, no for sqlite database

Specifies the username used to connect to the external PostgreSQL database.

--databaseUrl or --dburl

Type: string
Required: yes for postgres database, no for sqlite database

Specifies the full connection string to your PostgreSQL database.

If provided, this connection string takes priority over individual settings like --databaseUser or --databasePassword.

--databaseSslRejectUnauthorized or --dbsslru

Type: boolean
Required: no

Enables verification of the SSL certificate.

Enabling SSL verification is highly recommended for enhanced security when connecting to an external PostgreSQL database.

Refer to the official documentation for more.

--databaseSslCA or --dbsslca

Type: string
Required: no

Specifies the file path to a Certificate Authority (CA) certificate used for verification when connecting to the external PostgreSQL database with SSL enabled.

Refer to the official documentation for more.

--databaseSslKey or --dbsslk

Type: string
Required: no

Specifies the path to the SSL key file used by the external PostgreSQL server.

Refer to the official documentation for more.

--databaseSslCert or --dbsslc

Type: string
Required: no

Specifies the file path to the SSL certificate used by the external PostgreSQL server.

Refer to the official documentation for more.

--version

Required: no

Displays the Zuthree Manager version.