Table of Contents

• add-group
• create-config
• db-backup
• db-restore-from-dump-file
• db-restore
• import-legacy-config
• list-groups
• run-server
• service
• update-config
• activate-account
• activate-data-source
• create-admin-user
• create-apikey
• create-user
• deactivate-account
• deactivate-data-source
• grant-system-admin-privileges
• list-data-sources
• reset-dataset-cache
• set-user-password

Global Commands

add-group

Add a new group to the LOGS config file.

Options

Option	Description	Required
--name	The name of the group to add.	✅
--force	Force adding the group even if it already exists.	❌

Example

./LOGS add-group --name <value>

create-config

Create a new LOGS config file.

Options

Option	Description	Required
--output / -o	Path to directory where the config file should be created)	✅
--base-path	The base directory where LOGS will store data	❌
--config-dir-path	The path to the directory where LOGS will look for additional config files. Overrides base-path.	❌
--files-path	The path to the directory where LOGS will store files. Overrides base-path.	❌
--temp-path	The path to the directory where LOGS will store temporary files. Overrides base-path.	❌
--apps-path	The path to the directory where LOGS will store application files. Overrides base-path.	❌
--licenses-path	The path to the directory where LOGS will look for license files. Overrides base-path.	❌
--cache-path	The path to the directory where LOGS will store cache files. Overrides base-path.	❌
--logging-path	The path to the directory where LOGS will store log files. Overrides base-path.	❌
--chromium-path	The path to the Chromium executable.	❌
--license / -l	Path to directory containing LOGS license files	❌
--groups	Name of the groups that should be added to the config	❌
--db-user	Username for PostgreSQL	❌
--db-password	Password for PostgreSQL	❌
--db-host	Host for PostgreSQL	❌
--db-port	Port for PostgreSQL	❌
--db-name	Database name for PostgreSQL	❌
--force	Overwrite LOGS config if one already exists	❌
--http-port	Port for HTTP connections	❌
--https-port	Port for HTTPS connections	❌
--allow-http	Allow HTTP connections	❌
--certificate-path	The path to the SSL certificate file.	❌
--key-path	The path to the SSL key file.	❌
--devel	Use defaults appropriate for devel environments	❌
--logsadmin-override-password	DEVEL ONLY!!! Set a default password for all logsadmin users	❌

Example

./LOGS create-config --output <value>

db-backup

Create a compressed PostgreSQL backup using DB settings from the LOGS config.

Options

Option	Description	Required
--backup-dir	Directory where backup folders are created.	✅
--name	Backup folder name. Defaults to current UTC timestamp.	❌

Example

./LOGS db-backup --backup-dir <value>

db-restore-from-dump-file

Restore a PostgreSQL database using DB settings from the LOGS config and a given dump file.

Options

Option	Description	Required
--dump-file	Path to the dump file to restore from.	✅

Example

./LOGS db-restore-from-dump-file --dump-file <value>

db-restore

Restore a PostgreSQL database using DB settings from the LOGS config and a given LOGS backup directory.

Options

Option	Description	Required
--backup-dir	Directory where LOGS backup folders are created.	✅
--name	Backup folder name. Use 'latest' to restore from the most recent backup in the LOGS backup directory.	✅
--restore-config	Also restore the LOGS config file from the backup.	❌
--no-transaction	Do not use a single transaction for the restore process. This can help with large databases but may increase restore time.	❌
--drop-existing	Drop database objects before recreating them. This can help ensure a clean restore but may cause issues if there are dependencies between objects.	❌
--no-user-interaction	Skip confirmation prompts. Use with caution, especially when using --drop-existing, as this can lead to data loss without warning.	❌

Example

./LOGS db-restore --backup-dir <value> --name <value>

import-legacy-config

Import a legacy LOGS config-v1.yaml file and convert it to the new format.

Options

Option	Description	Required
--legacy-config	Path to the old-style LOGS config-v1.yaml file.	❌
--output	Path to write the new-style config file.	❌
--db-user	Username for PostgreSQL	❌
--db-password	Password for PostgreSQL	❌
--db-host	Host for PostgreSQL	❌
--db-port	Port for PostgreSQL	❌
--db-name	Database name for PostgreSQL	❌
--certificate-path	The path to the SSL certificate file.	❌
--key-path	The path to the SSL key file.	❌
--chromium-path	The path to the Chromium executable.	❌
--new-logs-base-path	The base path for the new LOGS installation.	❌

Example

./LOGS import-legacy-config

list-groups

Lists all groups

Example

./LOGS list-groups

run-server

Run the LOGS server

Example

./LOGS run-server

service

Manage the LOGS system service. Subcommands: status, log, start, stop, restart, enable, disable, install, uninstall.

Options

Option	Description	Required
--user	User to run the service as (only used by 'service install').	❌
--dry-run	Only show the generated unit file, do not install (only used by 'service install').	❌

Example

./LOGS service

update-config

Updates an existing LOGS config file.

Options

Option	Description	Required
--base-path	The base directory where LOGS will store data	❌
--config-dir-path	The path to the directory where LOGS will look for additional config files. Overrides base-path.	❌
--files-path	The path to the directory where LOGS will store files. Overrides base-path.	❌
--apps-path	The path to the directory where LOGS will store application files. Overrides base-path.	❌
--temp-path	The path to the directory where LOGS will store temporary files. Overrides base-path.	❌
--cache-path	The path to the directory where LOGS will store cache files. Overrides base-path.	❌
--logging-path	The path to the directory where LOGS will store log files. Overrides base-path.	❌
--python-path	Path to the python interpreter set up for the parsing system	❌
--parsing-path	Path to the parsing system	❌
--chromium-path	The path to the Chromium executable.	❌
--license	Path to LOGS license file	❌
--groups	Name of the groups that should be added to the config	❌
--db-user	Username for PostgreSQL	❌
--db-password	Password for PostgreSQL	❌
--db-host	Host for PostgreSQL	❌
--db-port	Port for PostgreSQL	❌
--db-name	Database name for PostgreSQL	❌
--http-port	Port for HTTP connections	❌
--https-port	Port for HTTPS connections	❌
--allow-http	Allow HTTP connections	❌
--certificate-path	The path to the SSL certificate file.	❌
--key-path	The path to the SSL key file.	❌
--devel	Use defaults appropriate for devel environments	❌
--logsadmin-override-password	DEVEL ONLY!!! Set a default password for all logsadmin users	❌

Example

./LOGS update-config

Group Commands

activate-account

Activates a user account.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login name of the user whose account status will be activated.	✅

Example

./LOGS activate-account --group <value> --login <value>

activate-data-source

Activates data sources.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--id	The ID of the data source to activate.	❌
--name	The name of the data source to activate.	❌
--activate-all	Activate all data sources.	❌

Example

./LOGS activate-data-source --group <value>

create-admin-user

Creates a new administrator user.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login name for the new user.	✅
--email	The email address for the new user.	✅
--last-name	The last name for the new user.	✅
--first-name	The first name for the new user.	❌
--password	The password for the new user. If not specified, a random password will be generated.	❌
--create-random-password	If set, a random password will be generated for the new user.	❌

Example

./LOGS create-admin-user --group <value> --login <value> --email <value> --last-name <value>

create-apikey

Creates a new API key for a specific user of the specified group.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login of the user for whom the password is being reset.	✅
--name	The name of the new API key.	✅
--read-only	If set, the API key will have read-only access.	❌
--password	The password of the user for whom the API key is being created. If not specified, the password will be prompted interactively.	❌

Example

./LOGS create-apikey --group <value> --login <value> --name <value>

create-user

Creates a new user.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login name for the new user.	✅
--email	The email address for the new user.	✅
--last-name	The last name for the new user.	✅
--first-name	The first name for the new user.	❌
--password	The password for the new user. If not specified, a random password will be generated.	❌
--create-random-password	If set, a random password will be generated for the new user.	❌
--role	The role to assign to the new user.	✅

Example

./LOGS create-user --group <value> --login <value> --email <value> --last-name <value> --role <value>

deactivate-account

Deactivates a user account.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login name of the user whose account status will be deactivated.	✅

Example

./LOGS deactivate-account --group <value> --login <value>

deactivate-data-source

Deactivates data sources.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--id	The ID of the data source to deactivate.	❌
--name	The name of the data source to deactivate.	❌
--deactivate-all	Deactivate all data sources.	❌

Example

./LOGS deactivate-data-source --group <value>

grant-system-admin-privileges

Grants system admin privileges to a user.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login of the user for which system admin privileges should be granted.	✅
--remove	If set, system admin privileges will be removed from the specified user instead of being granted.	❌

Example

./LOGS grant-system-admin-privileges --group <value> --login <value>

list-data-sources

Lists data sources.

Example

./LOGS list-data-sources

reset-dataset-cache

Recreates the cache for datasets.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--only-failed	Only reset the cache for failed datasets.	❌
--rerun-mapping	Rerun the metadata mapping for datasets. WARNING: Use with caution, as it may overwrite existing metadata data.	❌

Example

./LOGS reset-dataset-cache --group <value>

set-user-password

Sets the user password for the specified group.

Options

Option	Description	Required
--group	The group for which the command should be executed.	✅
--login	The login of the user for whom the password is being set.	✅
--password	The new password for the user. If not specified, a random password will be generated.	❌
--create-random-password	If set, a random password will be generated for the new user.	❌

Example

./LOGS set-user-password --group <value> --login <value>