Porteus Kiosk configuration parameters


List of configuration parameters supported by the latest Porteus Kiosk version can be found below.


Please mind that parameters may:

a) require other parameters to work, e.g. 'wifi_encryption=eap-peap' needs 'peap_username' and 'peap_password' to be provided

b) deactivate other functions, e.g. 'disable_navigation_bar=yes' deactivates 'autohide_navigation_bar' and 'disable_address_bar'

c) force certain values for other parameters, e.g. 'debug=yes' enforces 'homepage=/var/log/debug' and clears the whitelist.


If you are not sure about the kiosk config rules or parameters syntax then please take advantage of the Kiosk Wizard tool to generate your kiosk configuration.

CONNECTION SETTINGS

Connection type

Automatic network configuration (dhcp)

Manual network configuration (IP address)

Network interface name

Gateway

Netmask

DNS server

Wired authentication

EAP over LAN username

EAP over LAN password

SSID name

Hidden SSID name

Wireless encryption

WEP key

WPA/WPA2 Personal password

WPA/WPA2 Enterprise (EAP_PEAP) username

WPA/WPA2 Enterprise (EAP_PEAP) password

Dialup username

Dialup password

Dialup phone number


PROXY SETTINGS

Automatic proxy configuration (PAC files)

Manual proxy configuration

Proxy exceptions


BROWSER SELECTION

Default browser


CENTRAL MANAGEMENT

Remote kiosk management

Porteus Kiosk Server

Client ID


NETWORK SETTINGS

Firewall

ICMP protocol

Wake On LAN

Hostname aliases

Hostname


BROWSER SETTINGS

Homepage

Append string to the homepage

Homepage availability check

URL whitelist

URL blacklist

Private mode

Password manager

Search engine

Managed bookmarks

Import SSL certificates

Popup windows

Zoom controls

Default zoom level

User agent

File protocol

Browser preferences

Address bar

Autohide navigation bar

Navigation bar

Onscreen buttons

Onscreen buttons position

Toggle tabs

Refresh webpage

Virtual keyboard


SYSTEM SETTINGS

Automatic updates

Background wallpaper

Session idle time

Session idle action

Force session restarts

Persistence

Swap file

zRAM swap

Removable devices

Time zone

NTP server

RTC wake alarm

Scheduled action

Input devices

Primary keyboard layout

Secondary keyboard layout

Numlock key

Mouse cursor

Mouse cursor size

Mouse speed

Right mouse click

Touchscreen calibration

Screen settings

Screen rotate

Default system sound card

Default microphone

Sound volume

Session password

Run command

Shutdown menu


POWER SAVING OPTIONS

Screensaver

Screensaver slideshow

Screensaver archive update

Slide duration

Slide random

Screensaver video

Screensaver webpage

Display Power Management Signaling

Power saving - freeze

Power saving - standby

Power saving - suspend

Power saving - halt


ADDITIONAL COMPONENTS

UEFI support

Citrix Receiver

Additional fonts

SSH service

Root (administrator) password

SSH port

SSH localhost only

VNC service

VNC password

VNC port

VNC interactive mode

VNC query user mode

VNC localhost only

Printing support

Printer model

Printer connection type

Paper size

Silent printing

Share kiosk printer

Custom printer name


EXPERIMENTAL FEATURES

Hardware video decode

Watchdog timer


DEBUGGING OPTIONS

Linux kernel parameters

GPU driver

Kiosk debugging mode


CONNECTION SETTINGS


Function: Connection type

Parameter: connection

Description:

Connection type used in kiosk. If the parameter is not present then the system defaults to wired connection with automatic network configuration (dhcp).

Supported values:

connection=dialup connection=wifi connection=wired



Function: Automatic network configuration (dhcp)

Parameter: dhcp

Description:

DHCP is the default network configuration method used in kiosk. If the parameter is not present then the system defaults to automatic network configuration unless manual network configuration or dialup connection are used.

Supported value:

dhcp=yes



Function: Manual network configuration (IP address)

Parameter: ip_address

Requires: network_interface, default_gateway, netmask, dns_server

Deactivates: dhcp=yes, connection=dialup

Description:

Static IP address for specific network interface. If the parameter is not present then the system defaults to automatic network configuration (dhcp).

Examples:

ip_address=192.168.1.2 ip_address=10.0.0.2



Function: Network interface name

Parameter: network_interface

Requires: ip_address or ssid_name or hidden_ssid_name

Description:

Default network interface name. If the parameter is not present then the system won't be able to connect to the wired and wireless networks when manual network configuration is used.

Examples:

network_interface=eth1 network_interface=wlan0



Function: Gateway

Parameter: default_gateway

Requires: ip_address

Description:

Default gateway for the network traffic. If the parameter is not present then the system can communicate with localhost only when manual network configuration is used.

Examples:

default_gateway=192.168.1.1 default_gateway=10.0.0.1



Function: Netmask

Parameter: netmask

Requires: ip_address

Description:

32-bit mask used to divide an IP address into subnets and specify the networks available hosts. If the parameter is not present then the system defaults to '255.255.255.0' netmask.

Examples:

netmask=255.255.255.128 netmask=255.255.0.0



Function: DNS server

Parameter: dns_server

Requires: ip_address

Description:

Address of the server which does the translation (resolution) of domain names and hostnames into the corresponding IP addresses. If the parameter is not present then domain name resolution won't be possible when manual network configuration is used. Multiple parameter values must be separated by space.

Examples:

dns_server=192.168.1.1 dns_server=192.168.1.1 8.8.4.4



Function: Wired authentication

Parameter: wired_authentication

Requires: eapol_username, eapol_password

Description:

Wired authentication protocols used to prevent accessing the network by unauthorized PCs. The only supported protocol at the moment is EAP over LAN (802.1x). If the parameter is not present then connecting to networks requiring authentication is not possible.

Supported values:

wired_authentication=eapol wired_authentication=none



Function: EAP over LAN username

Parameter: eapol_username

Requires: wired_authentication=eapol

Description:

Username required for authenticating to 802.1x networks. If the parameter is not present then connecting to networks utilizing EAP over LAN authentication is not possible.

Example:

eapol_username=some_username



Function: EAP over LAN password

Parameter: eapol_password

Requires: wired_authentication=eapol

Description:

Password required for authenticating to 802.1x networks. If the parameter is not present then connecting to networks utilizing EAP over LAN authentication is not possible.

Example:

eapol_password=some_password



Function: SSID name

Parameter: ssid_name

Requires: network_interface

Optional: wifi_encryption

Description:

Wireless network (Access Point) name. If the parameter is not present then connecting to wireless networks is not possible unless hidden_ssid_name parameter is provided.

Example:

ssid_name=AP name



Function: Hidden SSID name

Parameter: hidden_ssid_name

Requires: network_interface

Optional: wifi_encryption

Deactivates: ssid_name

Description:

Wireless network (Access Point) which does not broadcast its name. If the parameter is not present then connecting to wireless networks is not possible unless ssid_name parameter is provided.

Example:

hidden_ssid_name=hidden AP name



Function: Wireless encryption

Parameter: wifi_encryption

Requires: ssid_name or hidden_ssid_name, wep_key or wpa_password or peap_username and peap_password

Description:

Wireless encryption scheme used to protect the connection. Supported methods are: WEP, WPA/WPA2 Personal, WPA/WPA2 Enterprise (EAP-PEAP). If the parameter is not present then connecting to encrypted wireless networks is not possible.

Supported values:

wifi_encryption=wep wifi_encryption=wpa wifi_encryption=eap-peap



Function: WEP key

Parameter: wep_key

Requires: wifi_encryption=wep

Description:

Key required to access WEP protected wireless networks. If the parameter is not present then connecting to WEP wireless network is not possible.

Example:

wep_key=1234567890



Function: WPA/WPA2 Personal password

Parameter: wpa_password

Requires: wifi_encryption=wpa

Description:

Password required to access WPA/WPA2 protected wireless networks. If the parameter is not present then connecting to WPA/WPA2 Personal wireless network is not possible.

Example:

wpa_password=some_password



Function: WPA/WPA2 Enterprise (EAP_PEAP) username

Parameter: peap_username

Requires: wifi_encryption=eap-peap

Description:

Username required to access WPA/WPA2 Enterprise protected wireless networks. If the parameter is not present then connecting to WPA/WPA2 Enterprise wireless network is not possible.

Example:

peap_username=some_username



Function: WPA/WPA2 Enterprise (EAP_PEAP) password

Parameter: peap_password

Requires: wifi_encryption=eap-peap

Description:

Password required to access WPA/WPA2 Enterprise protected wireless networks. If the parameter is not present then connecting to WPA/WPA2 Enterprise wireless network is not possible.

Example:

peap_password=some_password



Function: Dialup username

Parameter: dialup_username

Requires: dialup_password, dialup_phone_number

Deactivates: dhcp, ip_address

Description:

Username required to dial into PPP networks. If the parameter is not present then connecting to the PPP network is not possible.

Example:

dialup_username=vodafone



Function: Dialup password

Parameter: dialup_password

Requires: dialup_username

Description:

Password required to dial into PPP networks. If the parameter is not present then connecting to the PPP network is not possible.

Example:

dialup_password=vodafone



Function: Dialup phone number

Parameter: dialup_phone_number

Requires: dialup_username

Description:

Phone number required to dial into PPP network. If the parameter is not present then connecting to PPP network is not possible.

Example:

dialup_phone_number=*99#


PROXY SETTINGS


Function: Automatic proxy configuration (PAC files)

Parameter: proxy_config

Description:

Automatic proxy configuration through the PAC file. If the parameter is not present then the system won't use the proxy server unless manual proxy configuration (proxy parameter) is provided. Parameter value must have an URL format.

Examples:

proxy_config=http://192.168.1.10/files/proxy.pac proxy_config=http://domain.com/files/proxy.pac proxy_config=server://proxy.pac



Function: Manual proxy configuration

Parameter: proxy

Deactivates: proxy_config

Description:

Manual proxy configuration. Proxy server access can be protected with username and password. Proxy credentials can be remembered in the browser only when password manager is enabled. If the parameter is not present then the system won't use the proxy server unless automatic proxy configuration (proxy_config parameter) is provided. The following parameter value format must be preserved: 'ipaddress:port' or 'username:password@ipaddress:port'

Examples:

proxy=192.168.1.20:3128 proxy=username:password@192.168.1.20:3128



Function: Proxy exceptions

Parameter: proxy_exceptions

Requires: proxy

Description:

Do not use the proxy for specific IPs/hostnames. If the parameter is not present then network traffic goes through the proxy server (proxy must be configured) except for '127.0.0.1/localhost' which is excluded by default. Multiple parameter values must be separated by space.

Examples:

proxy_exceptions=192.168.1.10 proxy_exceptions=192.168.1.10 domain.local kernel.org


BROWSER SELECTION


Function: Default browser

Parameter: browser

Description:

Default browser used in the kiosk. When selecting Google Chrome you automatically agree to the terms and conditions of respective proprietary license: link. If the parameter is not present then the system defaults to the browser selected during installation. WARNING: if you use browser_preferences parameter then please remember to update browser preferences file (or disable 'browser_preferences=' parameter completely) when swapping the browser otherwise Firefox/Chrome may behave incorrectly.

Supported values:

browser=firefox browser=chrome


CENTRAL MANAGEMENT


Function: Remote kiosk management

Parameter: kiosk_config

Description:

Load kiosk configuration from the network during every system startup. The kiosk will reburn itself automatically when remote configuration is changed. This option allows central management of multiple kiosk PCs from one location. Please read the following document to find additional information about this powerful feature: link. Configs hosted on the web location can be protected with SSL and username/password. Configs hosted on Porteus Kiosk Server (server://config_name) are protected with SSL and SSH tunnels automatically. In case of doing manual edits to the config under Windows please make sure it's saved with ANSI or UTF-8 encoding as UTF-16 (Unicode) is not supported in kiosk. If the parameter is not present then it's not possible to remotely manage the kiosks through the central configuration file. NOTE: 'server://' part is a text string indicating connection type and not the IP or domain of your server.

Examples:

kiosk_config=https://john:secret@domain.com/kiosks/group1.txt kiosk_config=http://192.168.1.10/kiosks/group2.txt kiosk_config=ftp://192.168.1.15/kiosks/group3.txt kiosk_config=server://group4.txt



Function: Porteus Kiosk Server

Parameter: kiosk_server

Requires: client_id, additional_components=08-ssh.xzm, additional_components=09-x11vnc.xzm

Description:

Associate kiosk client with Porteus Kiosk Server. You need to provide domain/IP address and port on which the server is accessible. If you enable this function then SSH and VNC components must be activated to allow communication between the client and the server. If the parameter is not present then the kiosk can not be accessed and managed from the server. The following parameter value format must be preserved: 'domain:port' or 'IP:port'.

Examples:

kiosk_server=192.168.1.100:443 kiosk_server=domain.com:443 kiosk_server=domain.com:8443



Function: Client ID

Parameter: client_id

Requires: kiosk_server

Description:

Assign client ID to kiosk. Client ID is a port opened on the server side and used for communication between the server and the client. If client ID is set as 'automatic' then the ID number will be assigned automatically to the clients in range 2000 - 4999. You also have an option to manually assign a specific client ID to the kiosk. This is useful if you want to divide the clients into groups (e.g. 5000-5100, 6000-6100) or have them displayed in a specific order in the Administration Panel. Manually set ID numbers must be included in the following range: 1024 - 65534. NOTE: if VNC service is enabled on the server then relevant client ID must be skipped as VNC daemon listens on that particular port already. Sample: if VNC service is configured to accept incoming connections on port 15900 then parameter 'client_id=15900' can't be used in kiosk configuration as this port will be used by the server's VNC daemon. If the parameter is not present then the kiosk will default to 'client_id=automatic'.

Examples:

client_id=automatic client_id=5000 client_id=9000


NETWORK SETTINGS


Function: Firewall

Parameter: disable_firewall

Forces: allow_icmp_protocol=yes

Description:

The firewall controls network traffic for the kiosk. Default rules are set to reject all incoming/forwarded connections and allow outgoing traffic. Use this parameter only when you need to add a non standard service to the kiosk (e.g. apache/mysql servers) or allow incoming RTP/UDP network streams. If the parameter is not present or its value is set to 'no' then incoming/forwarded connections are not allowed.

Supported values:

disable_firewall=yes disable_firewall=no



Function: ICMP protocol

Parameter: allow_icmp_protocol

Description:

Answer incoming ICMP queries. This is useful when you want to check if the kiosk is up and running from another computer using the ping utility. If the parameter is not present or its value is set to 'no' then the ICMP protocol is blocked unless disable_firewall=yes parameter is used.

Supported values:

allow_icmp_protocol=yes allow_icmp_protocol=no



Function: Wake On LAN

Parameter: wake_on_lan

Description:

Wake up the kiosk PCs remotely by sending a magic packet to them. Please follow this guide to find about requirements: link. If the parameter is not present or its value is set to 'no' then it's not possible to wake the kiosk remotely.

Supported values:

wake_on_lan=yes wake_on_lan=no



Function: Hostname aliases

Parameter: hostname_aliases

Description:

Fixed aliases-to-address mappings for local hosts. Use this parameter if the kiosk is having troubles resolving non fully qualified domain names, e.g: http://server.local. If the parameter is not present then '127.0.0.1 localhost' is the only alias defined in the system. The following parameter value format must be preserved: 'IP domain' or 'IP domain hostname'. Multiple parameter values must be separated by a pipe character: '|'.

Examples:

hostname_aliases=10.0.0.15 domain.local hostname_aliases=10.0.0.15 first.domain.local first|10.0.0.15 second.domain.local second



Function: Hostname

Parameter: hostname

Description:

Custom hostname for the kiosk. Whitespaces in the name are not supported. This feature is useful if you want to identify the kiosk in the logs or through the shell prompt. If the parameter is not present then hostname defaults to "kiosk". If hostname is not defined and if Porteus Kiosk Server association is enabled then hostname is set to the client_id number automatically.

Examples:

hostname=kiosk1 hostname=location1-office3-kiosk5


BROWSER SETTINGS


Function: Homepage

Parameter: homepage

Description:

Custom homepage for the browser. SSL addresses (https://) and webpages hosted on non standard ports (http://domain.com:8888) are supported. Local pages from the offline content (e.g.: file:///var/www/localhost/index.html) are supported only when enable_file_protocol=yes parameter is provided. If the 'homepage' parameter is not present then the kiosk defaults to 'http://porteus-kiosk.org' for the homepage. The parameter value must have an URL format. To start the browser with multiple tabs opened, the parameter values must be separated by a pipe character: '|'.

Examples:

homepage=http://domain.com:8888 homepage=file:///var/www/localhost/index.html homepage=https://kernel.org|http://porteus-kiosk.org



Function: Append string to the homepage

Parameter: homepage_append

Description:

Append a specific string to the homepage which can be either the MAC address of the default network interface or kiosk hostname. This feature is useful if you want to identify the kiosk in your web server logs. If the parameter is not present then nothing is added to the homepage.

Supported values:

homepage_append=mac homepage_append=hostname



Function: Homepage availability check

Parameter: homepage_check

Description:

Perform a homepage check to make sure that online webpage is accessible before launching the browser. System notification is displayed every 10 seconds for the case when the homepage is not available. If the parameter is not present then the browser will be started straight after boot no matter if the homepage is available or not.

Example:

homepage_check=Homepage is not available - please contact your administrator



Function: URL whitelist

Parameter: whitelist

Description:

URLs and IPs which you want to allow in the browser. Everything else will be blocked. 'about:' and 'chrome:' protocols are blocked by default. 'file://' protocol can be controlled through the enable_file_protocol=yes parameter. Wildcards are enabled by default. Please do not use the "*" character as it breaks the URL filter. Multiple parameter values must be separated by space.

Examples:

whitelist=domain.com whitelist=mail.domain.com whitelist=domain.com/path whitelist=https://domain.com whitelist=https://domain.com/path/video.mp4 whitelist=192.168.1.5 whitelist=domain.com 192.168.1.5 https://kernel.org



Function: URL blacklist

Parameter: blacklist

Description:

URLs and IPs which you want to block in the browser. Everything else will be allowed. 'about:' and 'chrome:' protocols are blocked by default. 'file://' protocol can be controlled through the enable_file_protocol=yes parameter. Wildcards are enabled by default. Please do not use the "*" character as it breaks the URL filter. Multiple parameter values must be separated by space.

Examples:

blacklist=domain.com blacklist=mail.domain.com blacklist=domain.com/path blacklist=https://domain.com blacklist=192.168.1.5 blacklist=domain.com 192.168.1.5 https://kernel.org



Function: Private mode

Parameter: disable_private_mode

Description:

Disable private mode to let the browser remember form/search history, cookies and caches during the session. Signons (login/password) are not remembered unless enabled through a separate parameter below. A browser restart still returns to factory defaults. Use with caution as caches are saved in RAM (unless 'persistence=full' parameter is used) and may slow down the kiosk when the PC has low memory. If the parameter is not present or its value is set to 'no' then private (incognito) mode is used by default and nothing is remembered during the session.

Supported values:

disable_private_mode=yes disable_private_mode=no



Function: Password manager

Parameter: password_manager

Requires: disable_private_mode=yes

Optional: persistence=full

Description:

Password manager allows remembering logins and passwords to the websites and proxies. Credentials can be remembered persistently only when persistence=full parameter is used. This option is active only when private mode is disabled. Use with caution. If the parameter is not present or its value is set to 'no' then website logins are never remembered during the session.

Supported values:

password_manager=yes password_manager=no



Function: Search engine

Parameter: search_engine

Description:

Set default search engine for the browser. Google is the default search engine in kiosk as it is supposed to offer more accurate search results. If privacy is your top priority then you may enable DuckDuckGo engine which claims to never track, store or share users personal information. If the parameter is not present or its value is set to 'google' then Google's search engine is used by default.

Supported values:

search_engine=duckduckgo search_engine=google



Function: Managed bookmarks

Parameter: managed_bookmarks

Description:

Enable bookmarks toolbar in the browser UI and display provided webpages in it. Generic favicon will be used until the user clicks on the bookmark. You may define the bookmark name by placing it at the end of the bookmark URL and between the pipes. Spaces in the bookmark name must be replaced with an underscore. If the parameter is not present then the bookmark toolbar remains disabled in the browser. Parameter value must have an URL format. Multiple parameter values must be separated by space.

Examples:

managed_bookmarks=https://kernel.org http://porteus-kiosk.org file:///var/www/localhost/index.html managed_bookmarks=file:///media managed_bookmarks=https://kernel.org|Kernel_website|



Function: Import SSL certificates

Parameter: import_certificates

Description:

Import additional SSL certificates from a file (certificate.crt, certificate.pem, certificate.der) or directly from the domain to certificate database during every system boot. Self-signed certificates are not supported. If the parameter is not present then kiosk uses only SSL certificates which are available in the system by default. Following parameter value format must be preserved: 'URL', 'domain:port' or 'ip:port'. Multiple parameter values must be separated by space.

Examples:

import_certificates=http://domain.com/files/certificate1.crt http://domain.com/files/certificate2.pem import_certificates=192.168.1.100:8888 import_certificates=kernel.org:443 localdomain:1010 import_certificates=server://certificate1.crt server://certificate2.der



Function: Popup windows

Parameter: allow_popup_windows

Description:

Allow popup windows which are opened as new tabs in Firefox and directly on the screen in Google Chrome. If the parameter is not present or its value is set to 'no' then popup windows are blocked by the browser.

Supported values:

allow_popup_windows=yes allow_popup_windows=no



Function: Zoom controls

Parameter: disable_zoom_controls

Description:

Remove zoom controls from the Firefox UI, deactivate 'pinch to zoom' touch gesture and block Ctrl++/Ctrl+-/Ctrl+0 keyboard shortcuts. This is to prevent the users from changing zoom level in the browser. If Chrome has navigation bar enabled then it's still possible to zoom in and out through the browser menu. If the parameter is not present or its value is set to 'no' then zoom controls are available to the user.

Supported values:

disable_zoom_controls=yes disable_zoom_controls=no



Function: Default zoom level

Parameter: browser_zoom_level

Description:

Set a custom zoom level for the browser UI and webpages displayed in the kiosk. Ratio "1.5" equals to zoom 150% and makes the web content and the browser UI bigger. Ratio "0.8" equals to zoom 80% and makes the web content and the browser UI smaller. This option may be helpful to users with impaired vision. If the parameter is not present then default zoom level "1.0" (100%) is used in the browser application.

Examples:

browser_zoom_level=1.3 browser_zoom_level=2.0 browser_zoom_level=0.67



Function: User agent

Parameter: browser_user_agent

Description:

Modify user agent for the browser. This may be helpful in forcing layouts on some websites which are set to support certain browsers only (eg. Internet Explorer 6) or identifying the Porteus Kiosk sessions with an unique string in web server logs. Use with caution as many web pages rely on the user agent to know how to display the webpage (e.g. phone, tablet) and an incorrect string may break the display of these pages for the kiosk. If the parameter is not present then kiosk uses default user agent for each supported browser.

Example:

browser_user_agent=Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; Trident/6.0)



Function: File protocol

Parameter: enable_file_protocol

Description:

Allow browsing the file system using the 'file://' address in the browser. Use this parameter if you want to display offline content in a kiosk. If the parameter is not present or its value is set to 'no' then it's not possible to access the system files through the 'file://' protocol.

Supported values:

enable_file_protocol=yes enable_file_protocol=no



Function: Browser preferences

Parameter: browser_preferences

Description:

Add new or override default browser settings through an online text file containing browser preferences. Default Firefox preferences which we use in our system are stored in the /home/guest/.mozilla/firefox/c3pp43bg.default/prefs.js file, Chrome policies can be found in the /etc/opt/chrome/policies/managed/chrome.json file. For Firefox you may use all preferences listed in 'about:config' for relevant browser version, all available Chrome policies (mind some policies are only supported on Chrome OS, Windows or Mac systems and can not be used with our system) can be found here: link. Content of the online file will be added to default browser settings during every system boot. If preferences are doubled then the online file takes priority over local settings. In case of manual edits to the file under Windows please make sure its saved with ANSI or UTF-8 encoding as UTF-16 (Unicode) is not supported in kiosk. If the parameter is not present then the browser uses default kiosk settings/policies only. Parameter value must have an URL format. Use with caution as browser upgrade could make certain preferences obsolete. WARNING: If you use Porteus Kiosk Server then the browser preferences file must be added to the 'Client flies' tab in the Administration Panel and not to the 'Remote management' tab. WARNING: Firefox preferences and Chrome policies are NOT compatible. Please remember to update the browser preferences file (or disable 'browser_preferences=' parameter completely) in case you swap the browser through the browser parameter otherwise Firefox/Chrome may behave incorrectly. Sample files containing browser preferences can be found here: Chrome, Firefox. Please mind that policies and preferences must have a correct syntax. WARNING: When commenting out the preferences/policies you need to use the double backslash '//' characters instead of the hash '#' in the preferences file otherwise browser settings may be broken.

Examples:

browser_preferences=http://domain.com/files/chrome-policies.txt browser_preferences=http://domain.com/files/user.js browser_preferences=server://firefox-prefs.txt



Function: Address bar

Parameter: disable_address_bar

Requires: browser=firefox

Description:

Disable the address bar in Firefox but keep the navigation toolbar and toolbar buttons present. Useful for displaying company intranet pages and removing external browsing. If the parameter is not present or its value is set to 'no' then the address bar remains accessible in the browser unless disable_navigation_bar=yes parameter is used.

Supported values:

disable_address_bar=yes disable_address_bar=no



Function: Autohide navigation bar

Parameter: autohide_navigation_bar

Requires: browser=firefox

Description:

Hide the Firefox navigation bar when not in use. When bumping the mouse into the top of the window the navigation reappears again. If the parameter is not present or its value is set to 'no' then the navigation toolbar remains visible in the browser unless disable_navigation_bar=yes parameter is used.

Supported values:

autohide_navigation_bar=yes autohide_navigation_bar=no



Function: Navigation bar

Parameter: disable_navigation_bar

Deactivates: autohide_navigation_bar, disable_address_bar

Description:

Disable the navigation bar to convert the kiosk into a digital signage station displaying a picture, video or a single webpage. If the parameter is not present or its value is set to 'no' then the navigation bar remains accessible in the browser.

Supported values:

disable_navigation_bar=yes disable_navigation_bar=no



Function: Onscreen buttons

Parameter: onscreen_buttons

Requires: disable_navigation_bar=yes browser=firefox

Description:

Enable the onscreen buttons which allows to perform webpage navigation and other tasks when the navigation bar of the browser is disabled. This is useful e.g. when a user enters a blacklisted webpage and wants to go back to a previously viewed page. This parameter is available for Firefox and only when the navigation bar of the browser is disabled. Supported parameter values (buttons) are: back, forward, refresh, home, zoom-in, zoom-out, print, close. If the parameter is not present then onscreen buttons will not be visible on the kiosk's screen.

Examples:

onscreen_buttons=home onscreen_buttons=back forward refresh home onscreen_buttons=back forward refresh home zoom-in zoom-out print close



Function: Onscreen buttons position

Parameter: onscreen_buttons_position

Requires: disable_navigation_bar=yes browser=firefox onscreen_buttons

Description:

Use this parameter to move the onscreen buttons to the other edge of the kiosk's screen in case it's overlapping with the objects on your webpage. This parameter is active only for Firefox browser which works with the navigation bar disabled and onscreen buttons enabled. Supported parameter values are: left, right, top, bottom. If the parameter is not present then onscreen buttons are located on the left edge on the kiosk's screen.

Supported values:

onscreen_buttons_position=left onscreen_buttons_position=right onscreen_buttons_position=top onscreen_buttons_position=bottom



Function: Toggle browser tabs

Parameter: toggle_tabs

Requires: disable_navigation_bar=yes

Description:

Toggle browser tabs with defined time interval(s). If you want to set different number of seconds for each tab to be displayed on the screen then separate the numbers with a pipe '|' character. This option requires setting up multiple startup tabs in the homepage parameter and is active only when the navigation bar of the browser is disabled. NOTE: this parameter tells the system to emulate the "Ctrl+Tab" key shortcut every "X" seconds which breaks screensaver and session idle functions. Useful for digital signage purposes only. If the parameter is not present then browser tabs will never be toggled automatically by the system. Parameter value must be an integer (number of seconds).

Examples:

toggle_tabs=5 toggle_tabs=5|10|3


NOTE: First parameter from the samples above will toggle each tab equally every 5 seconds. Second parameter will display the first tab for 5 seconds, second tab for 10 seconds and third tab for 3 seconds.



Function: Refresh webpage

Parameter: refresh_webpage

Description:

Refresh browser page with defined time interval. NOTE: this parameter tells the system to emulate "F5" key press every "X" seconds which breaks screensaver and session idle functions. Use for digital signage purposes only. If the parameter is not present then the browser webpage will never be refreshed automatically by the system. Parameter value must be an integer (number of seconds).

Example:

refresh_webpage=5



Function: Virtual keyboard

Parameter: virtual_keyboard

Description:

Enable virtual keyboard extension for the Chrome and the Firefox browsers. Virtual keyboard will popup automatically when an input field is clicked on the webpage. NOTE: due to browser security policies extensions can not work on the input fields which are implemented through iframes. They also won't work on the browser's URL bar. Please use our customization service if you need a virtual keyboard (system application) which has these limitations lifted. If the parameter is not present or its value is set to 'no' then virtual keyboard extension is disabled.

Supported values:

virtual_keyboard=yes virtual_keyboard=no


SYSTEM SETTINGS


Function: Automatic updates

Parameter: automatic_updates

Description:

Automatic updates are enabled by default on all our systems. Updates can be controlled only through the remote management function. If you want to be super cautious then you can disable updates on all production systems and keep them enabled only on testing units (nested configurations are great for this purpose). Once the updates are tested by your internal team (they are always tested by us but it never harms to do it twice) then you can upgrade production systems by editing the 'automatic_updates=' parameter value in your remote kiosk config and rebooting the PCs. If the parameter is not present then the system works with updates enabled.

Supported values:

automatic_updates=yes automatic_updates=no




Function: Background wallpaper

Parameter: wallpaper

Description:

Use an online image (JPG or PNG) as your wallpaper. It will be downloaded and included in the kiosk ISO during system installation/reconfiguration. If the parameter is not present then the kiosk uses default wallpaper provided with the installation ISO. Parameter value must have an URL format.

Examples:

wallpaper=http://domain.com/files/default.jpg wallpaper=server://file.png



Function: Session idle time

Parameter: session_idle

Replaces old parameter: browser_idle

Description:

Set the time (in minutes) of inactivity after which the session will be restarted. This enhances user security by resetting the Firefox/Chrome or whole session when the user leaves the kiosk without closing his applications. Inactivity is considered as no mouse/keyboard/touch input. If the session is restarted and there is no user activity detected then it won't be restarted again until the activity is sensed. This is to save on CPU cycles and power. If the parameter is not present then the session will never be restarted automatically by the system. Parameter value must be an integer (number of minutes).

Example:

session_idle=5



Function: Session idle action

Parameter: session_idle_action

Requires: session_idle, session_password or root_password

Description:

Lock the session instead of restarting when the system is in idle. Session or root password must be enabled in the kiosk config so users would be able to unlock the kiosk screen. This option is useful if you want to protect the session from unauthorized access but do not want to close opened applications and loose data which may occur when the session is restarted. NOTE: Do not use this parameter if the kiosk is used publicly otherwise the session may get locked at idle. If the parameter is not present or its value is set to "restart" then the user session is restarted when the system is inactive.

Supported values:

session_idle_action=lock session_idle_action=restart



Function: Force session restarts

Parameter: session_idle_forced

Replaces old parameter: browser_idle_forced

Deactivates: session_idle_action

Description:

Force session restarts every X minutes when idling. This option could be useful in specific cases, e.g. when the browser homepage must be refreshed periodically for digital signage purposes. NOTE: this parameter breaks screensaver function. If the parameter is not present then the session will never be restarted forcibly. Parameter value must be an integer (number of minutes).

Example:

session_idle_forced=5



Function: Persistence

Parameter: persistence

Description:

Custom persistence level for the guest's home folder. Set the parameter value to 'session' in order to keep user data persistent when browser or session are restarted. Set it to 'full' to keep user data persistent all the time - even when the system is rebooted or powered down. Useful mostly with private mode disabled for the browser. NOTE: When persistence is set to 'full' then power cut may corrupt persistent data causing persistent partition to be reformatted during next system boot. Please make sure that the kiosk is powered down properly to prevent wiping the data. Use with caution. NOTE: When persistence is set to 'wipe' then guest's home folder is removed from the persistent partition. This is useful when you want to delete older browser profile, wipe saved cookies/passwords, downloaded files, etc. Home folder will be cleared during first boot after kiosk reconfiguration. Once the cleanup is performed you may revert to 'persistence=full'. If the parameter is not present then all user data is cleared when browser or session are restarted.

Supported values:

persistence=session persistence=full persistence=wipe persistence=none



Function: Swap file

Parameter: swapfile

Replaces old parameter: enable_swap

Description:

Create and use a swap file, the virtual memory extension of PCs real memory (RAM). Swap file is created on a persistent partition of the booting device. This option is less secure as some data may persist in the swap file. Booting media won't be spinned down when swap file is used. Enable this option only on PCs with low amount of RAM. If the parameter is not present then the swap file won't be created in the system. Parameter value must be an integer (number of megabytes).

Examples:

swapfile=1024 swapfile=4096



Function: zRAM swap

Parameter: zRAM

Description:

Compress data in RAM using the zRAM kernel feature. It is faster than using swap on a hard drive and creates more (virtual) memory than using RAM alone due to the compression used. If the parameter is not present then a zRAM swap device is not created and used in the system. Parameter value must be given as percentage. The maximum amount allowed is 50%.

Example:

zRAM=33%



Function: Removable devices

Parameter: removable_devices

Forces: enable_file_protocol=yes

Description:

Enable support for removable devices like usb sticks or flash cards. The only accepted filesystems are: FAT, exFAT, NTFS and XFS. Devices are mounted as read-only for Kiosk and read-write for Cloud and ThinClient variants under the /media folder and displayed in a separate tab in the browser. This feature allows kiosk users to read or upload images, PDFs and documents from external storage media or save files to it. If the parameter is not present or its value is set to 'no' then removable devices are never automounted in the system.

Supported values:

removable_devices=yes removable_devices=no



Function: Time zone

Parameter: timezone

Description:

Time zone used in the system. The hardware clock will be set through the NTP protocol during every kiosk boot if the PC is connected to the network. Make sure that your company firewall is not blocking the NTP protocol. A list of supported time zones can be found here: link. If the parameter is not present then the kiosk defaults to the time zone 'Factory'.

Example:

timezone=Europe/Warsaw



Function: NTP server

Parameter: ntp_server

Description:

Custom NTP server which will be used to sync hardware clock in kiosk. If the parameter is not present then the default NTP server is 'pool.ntp.org'.

Examples:

ntp_server=server.org ntp_server=192.168.1.100



Function: RTC wake alarm

Parameter: rtc_wake

Description:

Setup a RTC wake alarm to power up the kiosk at a certain hour:minute within each day of the week. Your PC motherboard must support this feature and 'Wake up events' must be enabled in the BIOS/EFI firmware in order to get this function working properly. If the system does not wake at the expected hour then please make sure you have set a correct time zone and that NTP server or NTP protocol are not blocked in your network. You can check the system time on this webpage: link (must be whitelisted if needed). If the parameter is not present then the kiosk is never powered up by the Real Time Clock.

Example:

rtc_wake=Monday-09:00 Tuesday-09:00 Wednesday-09:00 Thursday-09:00 Friday-09:00 Saturday-10:00



Function: Scheduled action

Parameter: scheduled_action

Description:

Run certain actions periodically. You can schedule a kiosk reboot, shutdown, browser restart, monitor power on/off, rsync action and more at specified hour and minute within each day of the week. NOTE: Linux shell syntax is supported so it's possible to execute commands one after another (separate them with a semicolon as in the sample below), send them to the background, perform tests, use pipes, etc ... If scheduled actions do not run at the expected hour then please make sure you have set a correct time zone and that NTP server or NTP protocol are not blocked in your network. You can check the system time on this webpage: link (must be whitelisted in kiosk config if needed). WARNING: please do not double 'scheduled_action=' parameters in your kiosk config, all actions must be included in a single 'scheduled_action=' parameter. Use semicolon ';' to separate your actions. If the parameter is not present then no scheduled actions are run in the kiosk.

Examples:

scheduled_action=Monday-16:00 Tuesday-17:30 Wednesday-17:30 Thursday-17:30 Friday-16:30 action:reboot scheduled_action=Monday-04:00 Wednesday-04:00 Friday-04:00 action:killall firefox chrome scheduled_action=Monday-13:00 Tuesday-13:00 Wednesday-13:00 Thursday-13:00 Friday-13:00 Saturday-13:00 Sunday-13:00 action:xset dpms force off; sleep 1h; xset dpms force on; sleep 4h; shutdown NOTE: In the last example we want the digital signage screen to be turned off at 13:00 for 1 hour lunch break, put it back on at 14:00, wait another 4 hours and finally power off the kiosk at 18:00. You can use the rtc_wake= parameter to wake the kiosk at e.g. 10:00 in the morning the next day.



Function: Input devices

Parameter: disable_input_devices

Deactivates: primary_keyboard_layout, secondary_keyboard_layout, disable_numlock, hide_mouse, right_mouse_click, touchscreen_calibration

Description:

Disable all input devices like mice, keyboards, touchpads, touchscreens, digital pens, etc so it's not possible to type, touch, scroll, draw or click on any objects on the screen. This is useful when the kiosk works in a digital signage mode. If the parameter is not present or its value is set to 'no' then input devices are enabled in the system.

Supported values:

disable_input_devices=yes disable_input_devices=no



Function: Primary keyboard layout

Parameter: primary_keyboard_layout

Optional: secondary_keyboard_layout

Description:

Set the primary keyboard layout for the system. The list of known keyboard layouts and variants can be found here: link. If the parameter is not present then kiosk uses 'us' keyboard layout as default. Following parameter value format must be preserved: 'layout' or 'layout:variant'.

Examples:

primary_keyboard_layout=pl primary_keyboard_layout=pl:qwertz primary_keyboard_layout=us:altgr-intl



Function: Secondary keyboard layout

Parameter: secondary_keyboard_layout

Description:

Set the secondary keyboard in the system. The list of known keyboard layouts and variants can be found here: link. Use Ctrl+Space key combination to switch between the layouts during the session. If the parameter is not present then the kiosk uses only the primary keyboard layout. Following parameter value format must be preserved: 'layout' or 'layout:variant'.

Examples:

secondary_keyboard_layout=de secondary_keyboard_layout=de:nodeadkeys secondary_keyboard_layout=fr:dvorak



Function: Numlock key

Parameter: disable_numlock

Description:

Disable the numlock key when the system boots. Useful if you are having trouble with keyboards that have number panels. If the parameter is not present or its value is set to 'no' then the numlock key remains untouched by the system. Default behavior (disabled/enabled) may be defined in the UEFI/BIOS.

Supported values:

disable_numlock=yes disable_numlock=no



Function: Mouse cursor

Parameter: hide_mouse

Description:

Hide the mouse cursor either permanently or after X seconds of inactivity. In the second case the parameter value must be provided as a number of seconds. This setting may be useful for touchscreens or when you want to display a static page or advertisement. If the parameter is not present then the mouse cursor is visible all the time on the screen unless the disable_input_devices=yes parameter is used.

Examples:

hide_mouse=yes hide_mouse=no hide_mouse=5



Function: Mouse cursor size

Parameter: mouse_cursor_size

Description:

Set default mouse cursor size. Large cursors may be helpful to users with impaired vision. If the parameter is not present or its value is set to 'normal' then the system defaults to the standard cursor theme.

Supported values:

mouse_cursor_size=large mouse_cursor_size=normal



Function: Mouse speed

Parameter: mouse_speed

Description:

Set custom mouse speed. Depending on your preferences you can make the mouse pointer move slower or faster on the kiosk screen. Value 20 is the default mouse speed. Values lower than 20 will make the mouse pointer moving slower, values higher than 20 will make the mouse pointer moving faster. The parameter value must be provided in the 0-100 range. If the parameter is not present then mouse speed is not changed.

Examples:

mouse_speed=10 mouse_speed=50



Function: Right mouse click

Parameter: right_mouse_click

Description:

Enable support for the right mouse click in the system. Right mouse click provides access to additional menus (e.g. for Chrome browser) and is usually not needed in kiosk. You can enable it to cover rare cases, e.g. it helps when working with online documents. If the parameter is not present or its value is set to 'no' then right mouse click remains disabled.

Supported values:

right_mouse_click=yes right_mouse_click=no



Function: Touchscreen calibration

Parameter: touchscreen_calibration

Description:

Provide touchscreen calibration data which can be obtained by running the 'xlibinput_calibrator --output-file-xinput-cmd=calibration' command on a Linux system booted on the target hardware. Certain touch controllers may require proprietary drivers which are not included in Porteus Kiosk by default. Please contact support@porteus-kiosk.org when in doubt. If the parameter is not present then the touch input device will use default system settings (may not work correctly). Multiple parameter values must be separated by a pipe character: '|'.

Examples:

touchscreen_calibration="Goodix Capacitive TouchScreen" "libinput Calibration Matrix" 0.006844 0.996458 -0.003191 1.010142 0.000401 0.000811 0.000000 0.000000 1.000000 touchscreen_calibration="Goodix Capacitive TouchScreen" "Evdev Axis Calibration" 32 1266 -1 799 6 touchscreen_calibration="Goodix Capacitive TouchScreen" "Evdev Axis Calibration" 32 1266 -1 799 6 | "Goodix Capacitive TouchScreen" "Evdev Axes Swap" 8 1



Function: Screen settings

Parameter: screen_settings

Deactivates: screen_rotate

Description:

Set custom screen parameters, disable certain video outputs, rotate screens or set them in certain position: e.g. create a video wall for digital signage. Data for the parameter (video output name, resolution, refresh rate) can be obtained by running 'xrandr' command over SSH on the target hardware. If the parameter is not present then the kiosk uses the maximum supported resolution, refresh rate and brightness (laptops only) for each video output. It also sets the normal position for each display and scales smaller screens to larger ones automatically. The following parameter value format must be preserved: 'video_output:screen_resolution:refresh_rate:brightness:rotate:position' or 'video_output:disabled'. Multiple parameter values must be separated by space. 'rotate' can have following attributes: normal, left, right, inverted 'position' can have following attributes: normal, same-as-video_output (mirroring mode), right-of-video_output (extended mode), left-of-video_output (extended mode), above-video_output (extended mode), below-video_output (extended mode) WARNING: video output name matters! 'HDMI1' is not the same as 'HDMI-1'. Please login to the kiosk over SSH and run 'xrandr' command to find proper names for video outputs otherwise the 'screen_settings' parameter won't work correctly.

Examples:

1) Rotate 'VGA-0' screen on left: screen_settings=VGA-0:1680x1050:60.00:normal:left:normal 2) Rotate 'HDMI-0' and 'HDMI-1' screens on right and set them in mirroring mode: screen_settings=HDMI-0:1920x1080:60.00:normal:right:normal HDMI-1:1920x1080:60.00:normal:right:same-as-HDMI-0 3) Setup 'DVI-0' and 'VGA1' screens in extended mode (smaller VGA screen goes on the right of DVI): screen_settings=DVI-0:1920x1080:60.00:normal:normal:normal VGA1:1366x768:60.00:normal:normal:right-of-DVI-0 4) Disable 'LVDS1' screen as its never used and causes troubles for the display: screen_settings=LVDS1:disabled



Function: Screen rotate

Parameter: screen_rotate

Description:

By default the kiosk will keep the screen in a normal position but you may also rotate it to some other position. This parameter applies to all connected screens. If you need to specify other screen attributes like resolution, refresh rate, brightness or position (mirroring/extended mode) then please use a more complex screen_settings parameter instead. If the parameter is not present then screens are never rotated.

Supported values:

screen_rotate=normal screen_rotate=left screen_rotate=right screen_rotate=inverted



Function: Default system sound card

Parameter: default_sound_card

Description:

Set the default sound card in case you have no sound in the system or when you want to redirect the sound output to an external monitor/TV. Data for the parameter can be obtained by running 'aplay -l' command on a Linux system booted on the target hardware. Sample output for card 0, device 9: card 0: NVidia [HDA NVidia], device 9: HDMI 3 [HDMI 3] If the parameter is not present then device 0, card 0 is set as default sound card (if available in the system). The following parameter value format must be preserved: 'card.device'.

Examples:

default_sound_card=0.1 default_sound_card=0.3 default_sound_card=1.0



Function: Default microphone

Parameter: default_microphone

Description:

Set the default microphone in case you have multiple capture devices in the system: webcam, USB mic, external sound card, etc. Data for the parameter can be obtained by running 'arecord -l' command on a Linux system booted on the target hardware. Sample output for card 1, device 0: card 1: C920 [HD Pro Webcam C920], device 0: USB Audio [USB Audio] If the parameter is not present then device 0, card 0 is set as default microphone (if available in the system). The following parameter value format must be preserved: 'card.device'.

Examples:

default_microphone=1.0 default_microphone=2.0



Function: Sound volume

Parameter: volume_level

Description:

Set a custom sound level for the kiosk. When set to 0% the sound will be muted. If the parameter is not present then sound volume is set to 90% by default. The parameter value must be provided as a percentage in the 0-100 range.

Example:

volume_level=66%



Function: Session password

Parameter: session_password

Description:

Protect the session with a password. Only authorized users will be able to use the system. If the parameter is not present then the kiosk session is unlocked to all users.

Example:

session_password=some_password



Function: Run command

Parameter: run_command

Description:

Run a custom command during system startup. Your commands will be executed once the network is established so utilities like rsync, wget and also graphical ones could work. Linux shell syntax is supported so it's possible to execute commands one after another, send them to the background, perform tests, use pipes, etc ... NOTE: Use following syntax to execute the command with a delay: ( sleep 10; your-command; ) & WARNING: please do not double 'run_command=' parameters in your kiosk config, all commands must be included in a single 'run_command=' parameter. Use semicolon ';' to separate your commands. If the parameter is not present then the system will not execute any custom commands during startup.

Examples:

run_command=dunstify -u low "command test" run_command=command1; command2 & test -e /etc/file && command3 || command4; cat /var/log/messages | command5 run_command=( while true; do sleep 1h; wget http://domain.com/files/video.mp4 -O /opt/storage/video.mp4; killall firefox; done; ) & run_command=wget http://domain.com/files/script.sh -O /opt/script.sh; sh /opt/script.sh



Function: Shutdown menu

Parameter: shutdown_menu

Replaces old parameter: shutdown_combination

Description:

Enable the shutdown/reboot/suspend/restart-session/lock kiosk menu by using the Ctrl+Alt+Del key combination, by pressing the PCs power button or by clicking on the "Exit" button in Cloud/ThinClient systems. NOTE: Use with caution if the kiosk is used publicly otherwise it may be powered off, put to sleep or locked by unauthorized users. If the parameter is not present or its value is set to 'no' then the shutdown menu is not available and the kiosk shuts down immediately once the PC power button is pressed.

Supported values:

shutdown_menu=shutdown reboot sleep restart-session lock shutdown_menu=reboot restart-session shutdown_menu=yes shutdown_menu=no


POWER SAVING OPTIONS


Function: Screensaver

Parameter: screensaver_idle

Description:

Set the time (in minutes) of inactivity after which the screensaver is started. Inactivity is considered as no mouse/keyboard activity. The default 'ripples' screensaver will be used unless you use the screensaver_slideshow, screensaver_video or screensaver_webpage parameter. If screensaver idle time is set to '0' then screensaver should start immediately after boot. This option may be useful for digital signage use cases. If the parameter is not present then the screensaver is never started and the kiosk works continuously. Parameter value must be an integer (number of minutes).

Examples:

screensaver_idle=5 screensaver_idle=0



Function: Screensaver slideshow

Parameter: screensaver_archive

Requires: screensaver_idle

Description:

ZIP archive (other compression formats are not supported) containing JPG or PNG images which will be used for the slideshow. The ZIP file should be kept on the server at all times as it will be downloaded during every kiosk boot. If the parameter is not present then 'ripples' effect is used for the screensaver. Parameter value must have an URL format.

Examples:

screensaver_archive=http://domain.com/files/images.zip screensaver_archive=server://images.zip



Function: Screensaver archive update

Parameter: screensaver_archive_update

Requires: screensaver_idle, screensaver_archive

Description:

Download ZIP archive containing screensaver slideshow images every X minutes. This is useful if you want to update the slideshow quickly without rebooting the system. If the parameter is not present then the slideshow is updated only when the system is restarted. Parameter value must be an integer (number of minutes).

Example:

screensaver_archive_update=60



Function: Slide duration

Parameter: slide_duration

Requires: screensaver_idle, screensaver_archive

Description:

Default slide duration for the slideshow is 5 seconds (time between loading new image). This parameter allows you to make it longer or shorter - depending on your preferences. If the parameter is not present then a new image is loaded every 5 seconds. Parameter value must be an integer (number of seconds).

Example:

slide_duration=5



Function: Slide random

Parameter: slide_random

Requires: screensaver_idle, screensaver_archive

Description:

Display screensaver slideshow images in random order rather than in alphabetical order. If the parameter is not present or its value is set to 'no' then images will be displayed in alphabetical order.

Supported values:

slide_random=yes slide_random=no



Function: Screensaver video

Parameter: screensaver_video

Requires: screensaver_idle

Description:

Video file which will be used for the screensaver. It should be kept on the server at all times so you can update it on demand without kiosk reconfiguration. Browser application is used to play the screensaver video and must support relevant codecs through the html5 audio/video tags. It is possible to use a local video for the screensaver. If the parameter is not present then the 'ripples' effect is used for the screensaver unless screensaver_slideshow or screensaver_webpage is used. Parameter value must have an URL format.

Examples:

screensaver_video=http://domain.com/files/video.mp4 screensaver_video=http://domain.com/files/video.webm screensaver_video=file:///opt/storage/video.ogv



Function: Screensaver webpage

Parameter: screensaver_webpage

Requires: screensaver_idle

Description:

Use a webpage as the screensaver. This is useful if you want to display any multimedia content embedded on a specific webpage when the system is not used. This function should be more configurable than static video or slideshow of images. If the parameter is not present then 'ripples' effect is used for the screensaver unless screensaver_slideshow or screensaver_video is used. Parameter value must have an URL format.

Examples:

screensaver_webpage=http://domain.com/files/index.html screensaver_webpage=file:///opt/storage/www/index.html



Function: Display Power Management Signaling

Parameter: dpms_idle

Replaces old parameter: enable_dpms=yes

Description:

DPMS turns the monitor off after 10 minutes of keyboard/mouse inactivity. This function is built into the hardware in every recent monitor. You can use this parameter to keep the screen active for a shorter or a longer period than default. If the parameter is not present then the monitor is never turned off automatically by the system. Parameter value must be an integer (number of minutes). The maximum supported value is 540 minutes.

Examples:

dpms_idle=5 dpms_idle=60



Function: Power saving - freeze

Parameter: freeze_idle

Description:

Freeze the kiosk when the computer is idle/inactive for a defined number of minutes. If the parameter is not present then the kiosk works continuously. Parameter value must be an integer (number of minutes).

Example:

freeze_idle=15



Function: Power saving - standby

Parameter: standby_idle

Description:

Standby the kiosk when the computer is idle/inactive for a defined number of minutes. If the parameter is not present then the kiosk works continuously. Parameter value must be an integer (number of minutes).

Example:

standby_idle=15



Function: Power saving - suspend

Parameter: suspend_idle

Description:

Suspend the kiosk when the computer is idle/inactive for a defined number of minutes. If the parameter is not present then the kiosk works continuously. Parameter value must be an integer (number of minutes).

Example:

suspend_idle=15



Function: Power saving - halt

Parameter: halt_idle

Description:

Power off the kiosk when the computer is idle/inactive for a defined number of minutes. If the parameter is not present then the kiosk works continuously. Parameter value must be an integer (number of minutes).

Example:

halt_idle=15


ADDITIONAL COMPONENTS


Function: UEFI support

Parameter: additional_components=uefi.zip

Description:

UEFI component allows booting Porteus Kiosk on PCs supplied with UEFI firmware and others supplied with traditional BIOS. If the parameter is not present then kiosk is able to boot only on the PCs supplied with the BIOS firmware. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=uefi.zip other_components



Function: Citrix Receiver application

Parameter: additional_components=11-citrix.xzm

Requires: browser=firefox

Description:

ICA Client for Citrix Presentation servers. Works as an associated application for the Firefox browser or standalone application for the variant ThinClient. When using this parameter you automatically agree to the terms and conditions of respective proprietary license: link. If the parameter is not present then it's not possible to connect to the Citrix servers from Firefox. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=11-citrix.xzm other_components



Function: Additional fonts

Parameter: additional_components=06-fonts.xzm

Description:

DejaVu, libertine, liberation-fonts and fonts for displaying characters from Asian (Chinese, Hindi, Korean, Japanese, Thai, Vietnamese) and other languages. If the parameter is not present then the kiosk may not be able to display the webpages with Asian languages and other content properly. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=06-fonts.xzm other_components



Function: SSH service

Parameter: additional_components=08-ssh.xzm

Requires: root_password

Optional: ssh_port, ssh_localhost_only

Description:

SSH (Secure shell) service allows to connect/communicate to the kiosk machine via the SSH protocol. If the parameter is not present then it's not possible to connect to the kiosk through a secure shell. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=08-ssh.xzm other_components



Function: Root (administrator) password

Parameter: root_password

Requires: additional_components=08-ssh.xzm or additional_components=10-printing.xzm

Description:

Root password that will be used to connect to the kiosk through SSH protocol or to setup printer parameters through the CUPS web interface. If the parameter is not present then a randomly generated password will be used making SSH connections almost impossible (unless bruteforced).

Example:

root_password=some_password



Function: SSH port

Parameter: ssh_port

Requires: additional_components=08-ssh.xzm

Description:

Port number on which the SSH service will be listening. Custom SSH port helps avoiding brute force attacks performed by the internet bots. Defined port is opened in the kiosk firewall configuration. If the parameter is not present then port 22 is used for incoming SSH connections.

Example:

ssh_port=25



Function: SSH localhost only

Parameter: ssh_localhost_only

Requires: additional_components=08-ssh.xzm

Description:

By default the SSH service listens on all available network interfaces. For security reasons it may be required to configure the SSH daemon to listen on localhost (127.0.0.1) address only. You may activate this function if you use Porteus Kiosk Server for handling SSH connections to the clients. In other cases this function will make the SSH service unusable unless the system is manually customized with a 3rd party application which tunnels SSH traffic to kiosk's localhost interface. If the parameter is not present then the SSH daemon listens on all available network interfaces.

Supported values:

ssh_localhost_only=yes ssh_localhost_only=no



Function: VNC service

Parameter: additional_components=09-x11vnc.xzm

Requires: vnc_password

Optional: vnc_port, vnc_interactive, vnc_query_user, vnc_localhost_only

Description:

VNC service allows one to connect to the graphical interface of the kiosk from another computer via the VNC protocol. This is useful for monitoring what's happening on the kiosk screen (e.g. digital signage case). Port 5900 is opened in the kiosk firewall configuration. NOTE: VNC traffic is unencrypted. When connection is initialized from Porteus Kiosk Server then VNC protocol is tunneled through secure SSH connection. If the parameter is not present then it's not possible to connect to the kiosk through the VNC protocol. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=09-x11vnc.xzm other_components



Function: VNC password

Parameter: vnc_password

Requires: additional_components=09-x11vnc.xzm

Description:

VNC password that will be used to connect to the kiosk through the VNC protocol. The password must be 8 characters or less. If the parameter is not present then a randomly generated password will be used making VNC connections almost impossible (unless bruteforced).

Example:

vnc_password=somepass



Function: VNC port

Parameter: vnc_port

Requires: additional_components=09-x11vnc.xzm

Description:

Port number on which the VNC service will be listening. Custom VNC port helps avoiding brute force attacks performed by the internet bots. Defined port is opened in the kiosk firewall configuration. If the parameter is not present then port 5900 is used for incoming VNC connections.

Example:

vnc_port=15900



Function: VNC interactive mode

Parameter: vnc_interactive

Requires: additional_components=09-x11vnc.xzm

Description:

VNC interactive mode gives full interactive control to the computer that connects to the kiosk through the VNC protocol. If the parameter is not present or its value is set to 'no' then VNC 'view only' mode is used for the connection unless 'vnc_query_user=yes' parameter is enabled.

Supported values:

vnc_interactive=yes vnc_interactive=no



Function: VNC query user mode

Parameter: vnc_query_user

Requires: additional_components=09-x11vnc.xzm

Description:

VNC 'query user' mode displays a popup window prior to establishing VNC connection and asks the kiosk user if incoming connection should be allowed, rejected or allowed in a view-only mode. If the parameter is not present or its value is set to 'no' then VNC 'view only' mode is used for the connection unless 'vnc_interactive=yes' parameter is enabled.

Supported values:

vnc_query_user=yes vnc_query_user=no



Function: VNC localhost only

Parameter: vnc_localhost_only

Requires: additional_components=09-x11vnc.xzm

Description:

By default the VNC service listens on all available network interfaces. For security reasons it may be required to configure the VNC daemon to listen on localhost (127.0.0.1) address only. You may activate this function if you use Porteus Kiosk Server for handling VNC connections to the clients, you will be tunneling VNC connection over SSH, utilizing Guacamole/NoVNC/websocket proxy or similar to tunnel VNC traffic to kiosk's localhost interface. If the parameter is not present then the VNC daemon listens on all available network interfaces.

Supported values:

vnc_localhost_only=yes vnc_localhost_only=no



Function: Printing support

Parameter: additional_components=10-printing.xzm

Requires: root_password, printer_model, printer_connection

Optional: paper_size, silent_printing, share_printer, printer_name

Description:

Printing support for local printers connected directly through the usb, parallel or serial ports and remote printers connected over the network through the http, ipp, lpd or socket protocols. If the parameter is not present then it's not possible to print in the kiosk. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=10-printing.xzm other_components



Function: Printer model

Parameter: printer_model

Requires: additional_components=10-printing.xzm

Description:

Printer model should be selected from the list of supported printers: link. If the parameter is not present then it's not possible to print in the kiosk.

Example:

printer_model=Canon MG3200 series



Function: Printer connection type

Parameter: printer_connection

Requires: additional_components=10-printing.xzm

Description:

Define if your printer is attached directly to the kiosk PC (using usb, parallel or serial cable) or accessed over the network using the http, ipp, lpd or socket protocols. If the parameter is not present then it's not possible to print in kiosk.

Examples:

printer_connection=direct printer_connection=http://ip_address:631/printers/printer_name printer_connection=ipp://ip_address/printers/printer_name printer_connection=lpd://ip_address/queue printer_connection=lpd://guest:tester@ip_address/queue printer_connection=socket://ip_address printer_connection=socket://ip_address:9100



Function: Paper size

Parameter: paper_size

Requires: additional_components=10-printing.xzm

Description:

Set default paper size for the printer. Paper size (e.g. A3) must be supported by the selected printer driver. You can find supported sizes in the print dialog window which appears in the browser (you can invoke it with 'Ctrl+P' shortcut). If the parameter is not present or its value is set to "default" then the printer uses default paper size which is set in the PPD driver.

Examples:

paper_size=default paper_size=A4 paper_size=Letter paper_size=A3 paper_size=Env10



Function: Silent printing

Parameter: silent_printing

Requires: additional_components=10-printing.xzm

Description:

Silent printing prevents users from changing printing related settings. If the parameter is not present or its value is set to 'no' then browser popups a window which allows setting the paper size, orientation, margins, header/footer and other settings.

Supported values:

silent_printing=yes silent_printing=no



Function: Share kiosk printer

Parameter: share_printer

Requires: additional_components=10-printing.xzm

Description:

Share kiosk printer through the CUPS service so other PCs can print through it. Use the following URI on the client side: ipp://kioskIP:631/printers/kiosk-printer. If the parameter is not present or its value is set to 'no' then the kiosk printer can not be used by other PCs.

Supported values:

share_printer=yes share_printer=no



Function: Custom printer name

Parameter: printer_name

Requires: additional_components=10-printing.xzm

Description:

Set a custom printer name. This feature allows you to find to which printer the kiosk prints in case you have more than one printer available in the workplace. If the parameter is not present then the system uses the default 'kiosk-printer' name for the printer. Spaces in the printer name are not allowed.

Examples:

printer_name=LaserJet-office printer_name=printer-reception


EXPERIMENTAL FEATURES


Function: Hardware video decode

Parameter: hardware_video_decode

Description:

Use a GPU card for processing video data. Hardware video decode is faster and more efficient than software video decode. Video files must be encoded with codecs which are supported by certain GPU models. Check this link for reference: link. You can also run 'vainfo' command over SSH on the target PC to find which video codecs are supported by your GPU. This function is especially useful for digital signage deployments. WARNING: this is an experimental feature and depending on the GPU model it may cause video playback problems, artifacts/glitches on the screen and even a whole system freeze. Please do not report any bugs to us if you have this function enabled in your kiosk config. If the parameter is not present or its value is set to 'no' then the system uses the CPU (software video decode) to process the video data.

Supported values:

hardware_video_decode=yes hardware_video_decode=no



Function: Watchdog timer

Parameter: watchdog

Description:

Enable watchdog timer in case your system crashes/hangs randomly during kiosk boot or freezes during GUI session e.g. due to faulty hardware or kernel driver problems. Watchdog should automatically reboot the PC after up to 3 minutes when a failing condition occurs. This function is especially useful for unattended deployments, e.g. digital signage. You can find the watchdog drivers which are supported by your PC hardware by connecting to the kiosk over SSH and running following command: /opt/scripts/find-watchdog You can test the watchdog driver by emulating a 'kernel panic' with following command (replace driver-name argument with a real name of the watchdog driver which you got from the previous command, e.g. iTCO_wdt): /opt/scripts/test-watchdog kpc driver-name Softdog is a software watchdog implementation and it won't reboot the PC when the kernel panic occurs. Use it only if hardware watchdog drivers are not available or when they are not working properly (sometimes the hardware reboot is blocked on the BIOS/motherboard level). WARNING: kernel panic will cause a complete PC freeze until the system is rebooted. Please do not test the watchdog drivers on production systems! WARNING: this is an experimental feature and when enabled it may cause issues on certain PC models. Use it only if your kiosk experiences troubles and must be forcibly rebooted in order to recover from fatal errors. If the parameter is not present then watchdog timer is not enabled in the system.

Examples:

watchdog=iTCO_wdt watchdog=wdat_wdt watchdog=sp5100_tco watchdog=softdog


DEBUGGING OPTIONS


Function: Linux kernel parameters

Parameter: kernel_parameters

Description:

Provide linux kernel parameters which will be added to the system bootloader configuration. Use this parameter only if you are having problems with kiosk hardware, e.g. power management does not work, wifi speed is slow, system freezes or hangs on reboot. Full list of supported kernel parameters can be found under this link. If the parameter is not present then only default kiosk parameters (e.g. "quiet") are passed to the kernel.

Examples:

kernel_parameters=debug kernel_parameters=acpi=force reboot=efi,pci,force kernel_parameters=intel_idle.max_cstate=1 i915.enable_rc6=0 kernel_parameters=tsc=reliable force_tsc_stable=1 clocksource=tsc clocksource_failover=tsc kernel_parameters=boot_from_usb



Function: GPU driver

Parameter: gpu_driver

Description:

Set a 2D DDX driver for your GPU card. WARNING: fbdev (framebuffer) and VESA drivers are generic, unaccelerated and offer less features than the default (Intel, AMD, nVidia, VIA, etc) and modesetting drivers. Use them only if you are having display problems in the kiosk. VESA driver requires additional parameter: "kernel_parameters=debug" - if this parameter is not set then VESA driver may not work correctly. If the parameter is not present or it's value is set to "default" then the system uses the default driver.

Supported values:

gpu_driver=default gpu_driver=modesetting gpu_driver=fbdev gpu_driver=vesa



Function: Kiosk debugging mode

Parameter: debug

Forces: homepage=/var/log/debug, enable_file_protocol=yes; disable_address_bar=no; disable_navigation_bar=no; autohide_navigation_bar=no; whitelist=""

Description:

Generate and display full system report during kiosk boot. The report can be sent using the online email account to support@porteus-kiosk.org in case of hardware/software/configuration issues. Certain kiosk settings are forced so please remember to disable this function when debugging is finished. If the parameter is not present or its value is set to 'no' then kiosk works in default (production) mode.

Supported values:

debug=yes debug=no