Porteus Kiosk configuration parameters


List of configuration parameters supported by latest stable Porteus Kiosk release 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

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

SSL certificates

Popup windows

Zoom controls

User agent

File protocol

Browser preferences

Navigation bar

Autohide navigation bar

Address bar

Toggle tabs


SYSTEM SETTINGS

Background wallpaper

Session idle time

Force session restarts

Persistence

Swap partitions

zRAM swap

Removable devices

Time zone

NTP server

Scheduled action

RTC wake alarm

Input devices

Primary keyboard layout

Secondary keyboard layout

Numlock key

Mouse cursor

Right mouse click

Touchscreen calibration

Screen settings

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

Display Power Management Signaling

Power saving - freeze

Power saving - standby

Power saving - suspend

Power saving - halt


ADDITIONAL COMPONENTS

UEFI support

Adobe Flash Player NPAPI plugin

Adobe Flash Player (legacy) NPAPI plugin

Java openjre NPAPI plugin

Citrix Receiver NPAPI plugin

Additional fonts

PXE client

SSH service

Root (administrator) password

SSH port

VNC service

VNC password

VNC connection mode

Printing support

Printer model

Printer connection type

Silent printing

Share kiosk printer


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 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 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 system defaults to automatic network configuration (dhcp).

Example:

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 system wont be able to connect to the wired networks when manual network configuration is used and wireless networks.

Example:

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 system can communicate with localhost only when manual network configuration is used.

Example:

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 system defaults to '255.255.255.0' netmask.

Example:

netemask=255.255.255.128 netemask=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 wont be possible when manual network configuration is used. Multiple parameter values must be separated by space.

Example:

dns_server=192.168.1.1 dns_server=192.168.1.1 8.8.4.4



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=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 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 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 system wont use the proxy server unless manual proxy configuration (proxy parameter) is provided. Parameter value must have an URL format.

Example:

proxy_config=http://192.168.1.10/files/proxy.pac proxy_config=http://domain.com/files/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. If the parameter is not present then system wont 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'

Example:

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 specified 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.

Example:

proxy_exceptions=192.168.1.10 proxy_exceptions=192.168.1.10 domain.local domain2.local


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 system defaults to the browser selected during installation.

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 to centrally manage multiple kiosk PCs from one location. Please read 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 central configuration file. Parameter value must have an URL format. NOTE: 'server://' part is a text string indicating connection type and not the IP or domain of your Server.

Example:

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 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 kiosk can not be accesses and managed from the server. The following parameter value format must be preserved: 'domain:port' or 'IP:port'.

Example:

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



Function: Client ID

Parameter: client_id

Requires: kiosk_server

Description:

Client ID is needed for association with Porteus Kiosk Server. It's a port opened on the server and used for communication with the client. If the parameter is not present then kiosk can not be accessed and managed from the server. The parameter value must be included in the following range: 1025 - 65535.

Example:

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 kiosk (e.g. apache/mysql servers) or allow incoming RTP/UDP network stream. 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 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 its 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 host. 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: '|'.

Example:

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 indentify the kiosk in the logs or through the shell prompt. If the parameter is not present and Porteus Kiosk Server association is enabled then hostname is set to the client_id number automatically.

Example:

hostname=some_hostname


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 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: '|'.

Example:

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 homepage is accessible before launching the browser. System notification is displayed for the case when 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.

Example:

whitelist=google whitelist=google.com whitelist=mail.google.com whitelist=192.168.1 whitelist=192.168.1.5 whitelist=google.com 192.168.1 http://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.

Example:

blacklist=google blacklist=google.com blacklist=mail.google.com blacklist=192.168.1 blacklist=192.168.1.5 blacklist=google.com 192.168.1 http://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 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 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

Description:

Password manager allows remembering logins and passwords to the websites. 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 default search engine in kiosk as it 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 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 bookmark toolbar remains disabled in the browser. Parameter value must have an URL format. Multiple parameter values must be separated by space.

Example:

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: SSL certificates

Parameter: import_certificates

Description:

Import additional SSL certificates from a file (certificate.crt, certificate.pem) or directly from the domain to certificate database during every system boot. 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', 'url:port' or 'ip:port'. Multiple parameter values must be separated by space.

Example:

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



Function: Popup windows

Parameter: allow_popup_windows

Description:

Allow popup windows which are opened as a new tabs in Firefox and directly on the screen in Gogole 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 in Chrome and block Ctrl++/Ctrl+- keyboard shortcuts. This is to prevent the users from changing zoom level in the browser. If Chrome has navigation bar enabled then its 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: 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 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 throug an online text file containing browser preferences. For Firefox you may use all preferences listed in 'about:config', Chrome policies can be found here: link. Content of the file will be added to default browser settings during every system boot. In case of doing manual edits to the file under Windows plese 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 browser uses default settings only. Parameter value must have an URL format. WARNING: use with caution as browser upgrade could make certain preferences obsolete. Sample files containing browser preferences can be found here: Chrome, Firefox. Please mind that policies and preferences must have correct syntax.

Example:

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



Function: Navigation bar

Parameter: disable_navigation_bar

Deactivates: autohide_navigation_bar, disable_address_bar

Description:

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

Supported values:

disable_navigation_bar=yes disable_navigation_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 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: 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 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: Toggle browser tabs

Parameter: toggle_tabs

Requires: disable_navigation_bar=yes

Description:

Toggle browser tabs with definied time interval. This option requires setting up multiple startup tabs in the homepage parameter and is active only when navigation bar of the browser is disabled. Useful for digital signage purposes. 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).

Example:

toggle_tabs=5


SYSTEM SETTINGS


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 kiosk uses default wallpaper provided with the installation ISO. Parameter value must have an URL format.

Example:

wallpaper=http://domain.com/files/default.jpg



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 user leaves the kiosk without closing his applications. Inactivity is considered as no mouse/keyboard/touch input. If session is restarted and there is no user activity detected then it wont be restarted again until the activity is sensed. This is to save on CPU cycles and power. If the parameter is not present then session will never be restarted automatically by the system. Parameter value must be an integer (number of minutes).

Example:

session_idle=5



Function: Force session restarts

Parameter: session_idle_forced

Replaces old parameter: browser_idle_forced

Description:

Force session restarts every X minutes when idling. This option could be useful in specific cases, e.g. when the default homepage must be refreshed periodically for digital signage purposes. If the parameter is not present then 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 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 system is rebooted or powered down. Useful mostly with private mode disabled for the browser. Use with caution. If the parameter is not present then all user data are wiped when browser or session are restarted.

Supported values:

persistence=session persistence=full persistence=none



Function: Swap partitions

Parameter: enable_swap

Description:

Use existing SWAP partitions. Installed kiosk occupies the whole device so swap must be located on separated media (e.g. kiosk burnt on CD/usb and swap available on a hard drive). This option is less secure as some data may persist in swap. Only enable this option on a PCs with a low amount of RAM. If the parameter is not present or its value is set to 'no' then swap partitions wont be used in the system.

Supported values:

enable_swap=yes enable_swap=no



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: FAT16/32, 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 kiosk defaults to 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 default NTP server is 'pool.ntp.org'.

Example:

ntp_server=server.org



Function: Scheduled action

Parameter: scheduled_action

Description:

Run certain actions periodically. You can schedule a kiosk reboot, shutdown, browser restart, rsync action and more at specified day/hour/minute within each day of the week. If the parameter is not present then no scheduled actions are run in kiosk.

Example:

scheduled_action=Monday-16:00 Tuesday-17:30 Wednesday-17:30 Thursday-17:30 Friday-16:30 action:reboot



Function: RTC wake alarm

Parameter: rtc_wake

Description:

Setup a RTC wake alarm to power up the kiosk at 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 parameter is not present then 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: 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 its not possible to type, touch, scroll, draw or click on any objects on the screen. This is useful when 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'.

Example:

primary_keyboard_layout=pl primary_keyboard_layout=pl:qwertz



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'.

Example:

secondary_keyboard_layout=de secondary_keyboard_layout=de:nodeadkeys



Function: Numlock key

Parameter: disable_numlock

Description:

Disable the numlock key when 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 numlock key remains untouched by the system. Default behavior (disabled/enabled) may be definied 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 mouse cursor is visible all the time on the screen unless the disable_input_devices=yes parameter is used.

Example:

hide_mouse=yes hide_mouse=no hide_mouse=5



Function: Right mouse click

Parameter: right_mouse_click

Description:

Enable support for the right mouse click in the system. Right mouse click provides an access to additional menus (e.g. for Chrome browser or flash content) 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 'xinput_calibrator' application on a Linux system booted on the target hardware. Certain touch controlers 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 touch input device will use defautl system settings (may not work correctly).

Example:

touchscreen_calibration="Goodix Capacitive TouchScreen" "Evdev Axis Calibration" 32 1266 -1 799 6



Function: Screen settings

Parameter: screen_settings

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 can be obtained by running 'xrandr' command on a Linux system booted on the target hardware. If the parameter is not present then 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.

Example:

screen_settings=DVI-0:1920x1080:60.00:normal:left:normal DVI-1:1920x1080:60.00:normal:left:same-as-DVI-0 screen_settings=DVI-0:1920x1080:60.00:normal:left:normal DVI-1:1920x1080:60.00:normal:left:right-of-DVI-0 screen_settings=LVDS1:disabled



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 external monitor/TV. Data for the parameter can be obtained by running 'aplay -l' command on a Linux system booted on the target hardware. 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'.

Example:

default_sound_card=0.3



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. 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'.

Example:

default_microphone=2.0



Function: Sound volume

Parameter: volume_level

Description:

Set a custom sound level for 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 kiosk session is unlocked to all users.

Example:

session_password=some_password



Function: Run command

Parameter: run_command

Description:

Run custom command during system startup. Your commands will be executed once network is established so utilities like rsync, wget and also graphical ones could work. Linux shell syntax is supported so its possible to execute commands one after another, send them to the background, perform tests, use pipes, etc ... If the parameter is not present then system will not execute any custom commands during startup.

Example:

run_command=dunstify -u low "command test" run_command=command1; command2 & test -e /etc/file && command3 || command4; cat /var/log/current/everything | command5



Function: Shutdown menu

Parameter: shutdown_combination

Description:

Enable the shutdown/reboot/suspend kiosk menu by using the Ctrl+Alt+Del key combination or by pressing the PCs power button. Do not use this option if the kiosk is used publicly otherwise it may be powered off with the keyboard by unauthorized users. If the parameter is not present or its value is set to 'no' then shutdown menu is not available and kiosk shuts down immediately once the PC power button is pressed.

Supported values:

shutdown_combination=yes shutdown_combination=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 or screensaver_video parameter. If the parameter is not present then screensaver is never started and kiosk works continuously. Parameter value must be an integer (number of minutes).

Example:

screensaver_idle=5



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.

Example:

screensaver_archive=http://domain.com/files/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 slideshow is updated only when 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 to make it longer or shorter - depending on your preferences. If the parameter is not present then 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 'ripples' effect is used for the screensaver unless screensaver_slideshow is used. Parameter value must have an URL format.

Example:

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



Function: Display Power Management Signaling

Parameter: dpms_idle

Replaces old parameter: enable_dpms=yes

Description:

DPMS turns the monitor off after X minutes of keyboard/mouse inactivity. If the parameter is not present then monitor is never turned off automatically by the system. Parameter value must be an integer (number of minutes).

Example:

dpms_idle=10



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 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 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 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: Adobe Flash Player NPAPI plugin

Parameter: additional_components=05-flash.xzm

Requires: browser=firefox

Description:

Adobe Flash Player NPAPI plugin allows Firefox browser to display web pages containing flash content. When using this parameter you automatically agree to the terms and conditions of respective proprietary license: link. If the parameter is not present then kiosk is not able to display the flash content in Firefox. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=05-flash.xzm other_components



Function: Adobe Flash Player (legacy) NPAPI plugin

Parameter: additional_components=05-flash_legacy.xzm

Requires: browser=firefox

Description:

Adobe Flash Player NPAPI plugin allows Firefox browser to display web pages containing flash content. This is the legacy version intended for older computers whose CPUs does not support SSE2 instruction: Pentium III, Pentium M, Athlon XP and older. When using this parameter you automatically agree to the terms and conditions of respective proprietary license: link. If the parameter is not present then kiosk is not able to display the flash content in Firefox. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=05-flash_legacy.xzm other_components



Function: Java openjre NPAPI plugin

Parameter: additional_components=07-java.xzm

Requires: browser=firefox

Description:

Java JRE (Java Runtime Environment) and the java NPAPI plugin allows Firefox to display web pages that contain java content. If the parameter is not present then the kiosk is not able to run the Java applets in Firefox. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=07-java.xzm other_components



Function: Citrix Receiver application/NPAPI plugin

Parameter: additional_components=11-citrix.xzm

Requires: browser=firefox

Description:

ICA Client for Citrix Presentation servers. Works as NPAPI plugin for the Firefox browser or standalone application for 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 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: PXE client

Parameter: additional_components=initrdpxe.xz

Description:

PXE client allows booting the kiosk on multiple PCs over the network. To setup the PXE server please follow the following document: link. If the parameter is not present then it's not possible to boot the kiosk through the PXE services. Multiple components must be separated by a space in the 'additional_components=' parameter.

Supported value:

additional_components=initrdpxe.xz other_components



Function: SSH service

Parameter: additional_components=08-ssh.xzm

Requires: root_password

Optional: ssh_port

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 kiosk through 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. 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: VNC service

Parameter: additional_components=09-x11vnc.xzm

Requires: vnc_password

Optional: vnc_interactive

Description:

VNC service allows to connect to the graphical interface of the kiosk from another computer via the VNC protocol. Useful for monitoring what's happening on the kiosk screen (e.g. digital signage case). Port 5900 is opened in the kiosk firewall configuration. 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 connection mode

Parameter: vnc_interactive

Requires: additional_components=09-x11vnc.xzm

Description:

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 it's value is set to 'no' then VNC 'view only' mode is used for the connection.

Supported values:

vnc_interactive=yes vnc_interactive=no



Function: Printing support

Parameter: additional_components=10-printing.xzm

Requires: root_password, printer_model, printer_connection

Optional: silent_printing, share_printer

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 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 its not possible to print in 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 through the network. If the parameter is not present then it's not possible to print in kiosk.

Example:

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: 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 to set 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 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


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 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 provided to the kernel.

Example:

kernel_parameters=debug kernel_parameters=acpi=force reboot=efi,pci,force kernel_parameters=intel_idle.max_cstate=1 i915.enable_rc6=0



Function: GPU driver

Parameter: gpu_driver

Description:

Set 2D DDX driver for your GPU card. WARNING: kernel modesetting and VESA drivers are generic, unaccelerated and offer less features than the default driver. Use them only if you are having display problems in 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 then system defaults to the native driver.

Supported values:

gpu_driver=modesetting 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 it's value is set to 'no' then kiosk works in default (production) mode.

Supported values:

debug=yes debug=no