Configuration

This page describes the configuration values and how to configure the application for yourself.

Configuration file

Each setting, that a user can enter into the application, may also be configured with a configuration file. Besides this the are some more configuration values, that the user can not change directly.

Default configuration file

The file src/data/config_global.ini contains the default configuration of the application and shows all supported values.

Configuration syntax

The configuration file uses INI file syntax and contains the three main sections [about], [gui] and [session].

For each main section there are subsections for each supported operating system, e.g. [about-windows], [gui-windows] and [session-windows]. If the application is running on a Windows system, the configuration values from the [*-windows] subsections are preferred. If a certain configuration in a [*-windows] subsection is not available, the application uses the configuration value from the corresponding main section.

Change configuration

There is no need to change the global configuration file (src/data/config_global.ini). Instead you can provide your own configuration file, that overrides the global default values, in one of these ways:

1. Copy your configuration file with the name config.ini next to the executable binary / application bundle. When the application is started, the values from config.ini are loaded in addition to src/data/config_global.ini.

2. Copy your configuration file with the name config.ini into the src/data folder and build your executable binary via build.tcl / build.bat. In this case the configuration file is embedded into the executable file and automatically loaded on startup.

Configuration values

Attribution settings

The following settings may be used in the [about] section of the configuration file:

Key	Description
company-name	company name, shown in the about dialog
company-website	company website, shown in the about dialog
company-website-title	title of the company website, shown on the link button in the about dialog
repository	URL of the applications source code repository, linked in the about dialog
authors	additional authors shown in the about dialog, multiple authors can be separated with semicolon

GUI settings

The following settings may be used in the [gui] section of the configuration file:

Key	Description
background	background color of dialogs and components
application-window-width	initial width of the application dialog (in px)
application-window-height	initial height of the application dialog (in px)
application-window-min-width	minimal width of the application dialog (in px)
application-window-min-height	minimal height of the application dialog (in px)
about-window-width	initial width of the about dialog (in px)
about-window-height	initial height of the about dialog (in px)
about-window-min-width	minimal width of the about dialog (in px)
about-window-min-height	minimal height of the about dialog (in px)
settings-window-width	initial width of the settings dialog (in px)
settings-window-height	initial height of the settings dialog (in px)
settings-window-min-width	minimal width of the settings dialog (in px)
settings-window-min-height	minimal height of the settings dialog (in px)
title-background	background color of titles, e.g. #c0c0c0 or a named color
title-foreground	foreground color of titles, e.g. #c0c0c0 or a named color
title-foreground-disabled	foreground color of disabled titles, e.g. #c0c0c0 or a named color
title-font-family	font family of titles, e.g. name of installed font, name of a standard font or name of a platform specific font
title-font-size	font size of titles (in pt)
title-font-weight	font weight of titles, e.g. normal or bold
subtitle-background	background color of subtitles, e.g. #c0c0c0 or a named color
subtitle-foreground	foreground color of subtitles, e.g. #c0c0c0 or a named color
subtitle-foreground-disabled	foreground color of disabled subtitles, e.g. #c0c0c0 or a named color
subtitle-font-family	font family of subtitles, e.g. name of installed font, name of a standard font or name of a platform specific font
subtitle-font-size	font size of subtitles (in pt)
subtitle-font-weight	font weight of subtitles, e.g. normal or bold
label-background	background color of labels, e.g. #c0c0c0 or a named color
label-foreground	foreground color of labels, e.g. #c0c0c0 or a named color
label-foreground-disabled	foreground color of disabled labels, e.g. #c0c0c0 or a named color
label-font-family	font family of labels, e.g. name of installed font, name of a standard font or name of a platform specific font
label-font-size	font size of labels (in pt)
label-font-weight	font weight of labels, e.g. normal or bold
button-background	background color of buttons, e.g. #c0c0c0 or a named color
button-background-active	background color of active buttons, e.g. #c0c0c0 or a named color
button-foreground	foreground color of buttons, e.g. #c0c0c0 or a named color
button-foreground-active	foreground color of active buttons, e.g. #c0c0c0 or a named color
button-foreground-disabled	foreground color of disabled buttons, e.g. #c0c0c0 or a named color
button-font-family	font family of buttons, e.g. name of installed font, name of a standard font or name of a platform specific font
button-font-size	font size of buttons (in pt)
button-font-weight	font weight of buttons, e.g. normal or bold
checkbutton-background	background color of checkboxes, e.g. #c0c0c0 or a named color
checkbutton-background-active	background color of active checkboxes, e.g. #c0c0c0 or a named color
checkbutton-foreground	foreground color of checkboxes, e.g. #c0c0c0 or a named color
checkbutton-foreground-active	foreground color of active checkboxes, e.g. #c0c0c0 or a named color
checkbutton-font-family	font family of checkboxes, e.g. name of installed font, name of a standard font or name of a platform specific font
checkbutton-font-size	font size of checkboxes (in pt)
checkbutton-font-weight	font weight of checkboxes, e.g. normal or bold
entry-background	background color of text fields, e.g. #c0c0c0 or a named color
entry-background-disabled	background color of disabled text fields, e.g. #c0c0c0 or a named color
entry-background-readonly	background color of readonly text fields, e.g. #c0c0c0 or a named color
entry-foreground	foreground color of text fields, e.g. #c0c0c0 or a named color
entry-foreground-disabled	foreground color of disabled text fields, e.g. #c0c0c0 or a named color
entry-font-family	font family of text fields, e.g. name of installed font, name of a standard font or name of a platform specific font
entry-font-size	font size of text fields (in pt)
entry-font-weight	font weight of text fields, e.g. normal or bold
status-background	background color of the status bar, e.g. #c0c0c0 or a named color
status-foreground	foreground color of the status bar, e.g. #c0c0c0 or a named color
status-foreground-disabled	foreground color of disabled elements in the status bar, e.g. #c0c0c0 or a named color
status-font-family	font family of text in the status bar, e.g. name of installed font, name of a standard font or name of a platform specific font
status-font-size	font size of text in the status bar (in pt)
status-font-weight	font weight of text in the status bar, e.g. normal or bold

Session settings

The following settings may be used in the [session] section of the configuration file:

Key	Description
host	IP / hostname of the listening VNC client
port	port nr of the listening VNC client
vnc-application	path to VNC server application
vnc-parameters	parameters for the VNC server application
ssh-enabled	SSH encryption is enabled (yes or no)
ssh-application	path to OpenSSH application
ssh-port	port nr of the SSH server
ssh-user	username to connect with the SSH server
ssh-keyfile	path to SSH key file

Example for a custom configuration

For the customers of OpenIndex.de we're using the following customized config.ini:

[about]
company-name = OpenIndex
company-website = http://openindex.de/
company-website-title = OpenIndex.de

[session]
host = openindex.de
ssh-enabled = yes
ssh-user = support
ssh-port = 55555

SSH private key

If SSH encryption is used, you can provide the SSH private key (RSA or DSA) together with the application.

1. Copy your ssh.key file next to the executable binary / application bundle. When the application is started, the SSH key is automatically preselected by the application.

2. Copy your ssh.key file into the src/data folder and build your executable binary via build.tcl / build.bat. In this case the SSH key file is embedded into the executable file and automatically loaded on startup.

Notice

You can create a ssh.key file with the ssh-keygen.tcl / ssh-keygen.bat script or with the following command:

ssh-keygen -t rsa -b 4096 -f ssh.key

The ssh.key file should not use a passphrase.