Configuration

This page contains detailed information on what options are available on Zuthree Manager. On how to provide this configuration see Setup page.

To see the list of available options you can also run a command on your machine:

sudo zuthree --help

Zuthree Manager with 3 build-in commands:

• start - a default command that does not require to be called directly. In normal scenarios this is handled by a linux service running on your machine. You can use it to spawn multiple instances of Zuthree Manager, i.e. for testing.
• save-config - lets you save all provided arguments to a config file. This will not require to run Zuthree Manager with extra arguments through the service or command line executions.
• update-license - lets you update the license file through command line instead of manually updating the license file.

How to use options

Below you will find list of all options that can be provided to Zuthree Manager.

To provide given option to the application simply write its argument prefixed with --, i.e. sudo zuthree --httpPort 3000. If an option has a shorthand argument provided you can use it by prefixing it with a single -, i.e. sudo zuthree -p 3000. You should not specify both at the same time. sudo zuthree -p 3000 is the same as sudo zuthree --httpPort 3000.

String and number options require you to provide the parameter value after it, i.e. sudo zuthree --storage /home/myUser/zuthree-storage. Boolean arguments are flags and does not require value to be provided. By default, they’re not set (so their value is understood as false/off). By providing it (i.e. sudo zuthree --noLogFiles) you’re setting its value to true/on.

start and save-config commands arguments

Networking options

TFTP port

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

Port for the TFTP part of Zuthree Manager server. In most cases you should not update this value as phones will be using default tftp port. Useful for running multiple instances of zuthree, i.e. for testing.

HTTP port

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

Port for the HTTP part of Zuthree Manager server. This is the port that your web browser uses to access your application. In case you do not use any reverse proxy solutions (like nginx) you should set it to default HTTP port 80.

Host name and port for Zuthree Manager

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

Network name for server on which zuthree manager is running. This is used by additional applications on the phone to identify from where they should pull additional resources like xml apps. This option should contain both host and port for HTTP (either value provided in HTTP port option or information that will be parsed by your reverse proxy).

General configuration options

Storage folder location

Argument: storage or storageFolder
Shorthand argument: s
Type: string
Default value: /root/.zuthree/storage
Required: no

Relative or absolute path for your application files. All files used by tftp are stored there alongside database and logs.

Output format

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

Defines how application logs it work to the console or system journal. While pretty is the default, more human-readable option, json or logstash might be useful for your external monitoring software

Log files

Argument: noLogFiles
Type: boolean
Default value: false
Required: no

By default, Zuthree Manager stores it logs from last 7 days in storage folder in addition to the system journal. This flag gives you an option to disable those additional logs.

Config location

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

Path to custom configuration file in case you would like to keep different configurations (useful for i.e. testing on multiple instances). System service running Zuthree Manager reads the config from default /root/.zuthree/config.json path. Changing it would require manual update to service file.

Database options

Database password

Argument: 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

Password for default SQLite database that Zuthree Manager uses internally. This is your password that will protect your data. For save-config command this option should not be used as it stores your password in plain text in config file. ZUTHREE_DATABASE_PASSWORD environment variable should be used.

Database type

Argument: databaseType or db
Shorthand argument: d
Type: string
Possible values: sqlite, postgres
Default value: sqlite
Required: no

Type of database to be used by Zuthree Manager. Default sqlite value uses a SQLite Database that stores its content in a file in storage folder. postgres option is provided to use with external instance of Postgres database and requires setting up additional parameters from Database options.

Database username

Argument: databaseUser or dbu
Type: string
Required: yes for non-sqlite database

Database user to connect to external database.

Database username

Argument: databaseHost or dbh
Type: string
Required: yes for non-sqlite database

Database host of external database.

Database url connection string

Argument: databaseUrl or dburl
Type: string
Required: yes for non-sqlite database

Full database connection string to your database. If provided it takes priority over database username and password options.

SSL verification

Argument: databaseSslRejectUnauthorized or dbsslru
Type: boolean
Required: no

Verification option for external database to reject unauthorized connections if set to true.
For more information see: https://node-postgres.com/features/ssl

Certification Authority certificate

Argument: databaseSslCA or dbsslca
Type: string
Required: no

File path to CA certificate for external database.
For more information see: https://node-postgres.com/features/ssl

Certificate key

Argument: databaseSslKey or dbsslk
Type: string
Required: no

File path to key for external database.
For more information see: https://node-postgres.com/features/ssl

Certification Authority certificate

Argument: databaseSslCert or dbsslc
Type: string
Required: no

File path to certificate for external database.
For more information see: https://node-postgres.com/features/ssl

Debugging options

Version

Argument: version Required: no

Show Zuthree Manager version instead of running the application.