Virola Server command line options
Whether you are running Virola Server from a terminal (Linux) or using the GUI (Windows), you may need to set certain options before starting the server. To do this, you can use the set of command line options we have implemented for you. These options are the same across all versions of Virola Server, regardless of the operating system.
Command | Explanation |
---|---|
-h , --help
|
Displays information about available command line options. |
--help-all
|
Displays information about available command line options, including generic Qt options. |
-v , --version
|
Displays the server version. |
---listen <HOST:PORT>
|
Makes Virola Server listen on the specified interface
(HOST:PORT ).
|
--storage-dir <STORAGE_DIR>
|
Specifies the directory where Virola Server stores the database and attachments.
The default storage directory is:
|
--create-admin
|
Creates a new user with administrator rights in Virola Server. |
--change-password
|
Changes the password of an existing user in Virola Server. |
--username <USER_NAME>
|
Specifies the username for the --create-admin or
--change-password option. The username must be unique,
between 1 and 128 characters long, and contain only ASCII printable characters.
|
--password <USER_PASSWORD>
|
Specifies the password for the --create-admin or
--change-password option. The password must be between 1 and 128
characters long and should include a mix of uppercase and lowercase Latin letters,
numbers, and special characters.
|
web-api-session-timeout <T>
|
Specifies the timeout (in seconds) for invalidating a user session after a web API client request. The default value is 1800 (30 minutes). |
--mobile-session-timeout <T>
|
Specifies the timeout (in seconds) for invalidating a user session after
login from a mobile client. The default value is 604800 (7 days).
Note: Each time a mobile client app is opened, it is considered a new login. If a user does not open the client app within the specified period, their session will be terminated. |
--web-root-dir <WEB_ROOT_DIR>
|
Specifies the path to the directory containing static web resources. This option is currently not in use but will become relevant once the web-based Virola Client is released. |
--log-dir <LOGS_DIR>
|
Specifies the directory where Virola Server stores log files. Setting this option enables the server to start writing logs to a file. |