Copyright © 2021 Linutop SAS
Linutop Kiosk is a powerful software for quickly setup a secure web access, a digital signage or a MultiMedia Player. The Linutop-kiosk application is included in Linutop OS and available for PC or Raspberry Pi
Linutop-Kiosk in kiosk mode allows you to setup:
Linutop-Kiosk in digital signage player mode allows you to setup:
The Linutop Kiosk offers 3 modes of operation:
This mode allows to restrict various elements to make the browsing session very secure.
This mode allows to easily configure slideshows (playlist) of web pages, streams, pictures, PDF, sound, and videos locally or remotly.
Both modes can be used at the same time, allowing to use the digital signage mode as a screen saver when the kiosk is not used.
The Linutop Kiosk is divided in two software:
1) is the main application (player).
In themenu, entry.
2) is the configuration manager.
In themenu, entry. This application is executed with the administrator rights. It defines how the main application will behave.
Linutop Kiosk is included into linutop OS Operating system.
Linutop Kiosk is accessible from theMenu
Starting the configuration tool will display the following screen:
The top section of the Kiosk mode) lets you choose the mode:tab (
This choice will enable thetab. The application displays the choice of playlist sources and the content of a playlist in a loop.
This choice will enable thetab. The main application will behave like a standard web browser, with the restrictions you'll setup (whitelist or blacklist of URLs, maximum session duration...).
This choice will simply enable all the features of the main application. At the end of browsing session, the digital signage feature will start to act like a screen saver.
The next section (Configuration) allows to setup a few things:
If selected, the Kiosk will start in fullscreen mode.
If selected, the default system screen saver will never start.
If selected, the Kiosk will automatically start when the system boots. It also restart this application in case of a crash.
This option places the Player at the top left of the screen with a resolution defined by its width and height. This allows to directly accommodate the largest number of led panel.
If selected, a password will be requested. This password will be asked to the user when he tries to exit the application. (ESC or CTRL + q or Double click the wheel in "dynamic display" mode)
If checked, all values will be reset by default.
Thetab of the configuration tool lets you define how the web browser should behave. It is split in 3 parts:
These parameters define how the Kiosk will behave, and what will be shown to the user.
Do not display the navigation toolbar. This setting can be activated if you allow navigation on only one website (a catalog of your shop articles for instance).
If checked, the user can acess the file system, and acess a usb key for example for downloading purpose.
If checked, abutton will let the user explicitely clear his session. This will clear all cookies, all site authentications and clear the browsing history.
If checked, the user can print a webpage
If unchecked, the application will wait for an external event to decide to start a web session.
URL to display when a session starts.
URL to display when a new tab is opened.
Defines how long (in seconds) the application should wait before cleaning the current session if the user is inactive. Setting this parameter to 0 will forbid the application to clean the session.
Zoom Factor allows enlarge the web pages. A 1.0 Zoom is 100% and 2.0 is 200%.
Allows to select the default font used when displaying web pages (in kiosk mode and in digital signage mode).
If the external browser option is checked, the application browser will be replaced by an external one to maximize navigation compatibility (by default, it is Firefox on PC or Chromium on XS (raspberry Pi)). This option will launch the external browser with the selected url.
To improve security in this configuration, you will have to secure the external browser first. to do so you can use plugins like R-Kiosk or mKiosk for firefox
To use another web browser you need to edit this line in the main configuration file (/home/linutop or pi/.config/linutop/preferences)
external_browser_cmd=chromium-browser --kiosk %u
--kiosk enable the chromium built-in kiosk option (fullscreen)
%u allows to pass the URL to the chromium browser
This feature allows to start an application in secure kiosk mode you just need the launch command configured in the main configuration file (/home/linutop or pi/.config/linutop/preferences)
The Kiosk can be configured to forbid access to some Internet resources. You can define a list of URLs that will be used either as a blacklist (list of forbidden URLs, everything else is allowed) or as a whitelist (only the listed URLs are allowed). You can obviously choose to not restrict the URLs.
The list uses a set of URL patterns. The * has a special meaning. It symbolises any letter, as many as you want. For instance, to allow anything hosted by Google, you can use:
http*://*.google.*This will allow to use both http and https protocols (http*://), on any subdomain (*.google) of any country (google.*).
The patterns can be defined as regular expressions. If you don't know what that is, you just don't need this! If you are familiar with regex's, have fun!
By default the file:// protocol, allowing the browser to act as a file browser, is forbiden. To enable this feature, check thecheckbox.
If you use the Linutop Kiosk for a public access point, you probably want to check a few things to secure the browser and the system.
The browser offers standard features for such an application:
Thetab of the configuration tool defines how the display part of the application should behave.
The section frameallows to setup how the data to be displayed should be retrieved. Two distinct methods can be used:
Linutop Kiosk is connected to a Linutop.TV server :
Linutop Kiosk is configured with a local playlist:
Linutop Kiosk can accommodate any screen resolution and orientation (landscape, portrait) for Image, PDF, web page, some limitations might appear for video depending on hardware limitation. Video HD (720p, 1080p), Video 4K, resolution, screen orientation and other settings can be configured in the linutop configuration pannel.
By selectingbutton, If you are connected to the Internet, the public demo channels will appear in the window, you can display their content with a double click.
The Linutop TV service makes it easy to generate such playlists. If you have a Linutop TV account, the tab of the Linutop Configuration Panel offers a simple way to configure the Linutop Kiosk.
Connected on the internet, Linutop TV service can be automaticaly updated. For a demo, you can just double click on a channel.
Private playlist server
A playlist can be downloaded from a web or ftp site. To do so, check thebutton, and set the URL to access the file. This remote playlist uses an XML format, offering advanced features. See the Scheduler section for details.
With local playlist, you can directly create a playlist.
To add items to this list, simply press thebutton and select the file from the file manager. The type of the file (video or image) will be detected automatically using the file name extension or protocol. URLs must be prefixed with the access protocol (usually http://, rtsp://, smb:// or file:///).
Local or network Directories (folders) can be added to a local playlist and all it's playable content will be shown with the same duration (except videos).
Items can be ordered in the tree using the arrow keys. You can define how long each item will be displayed (in seconds) in thecolumn. Videos don't use this parameter, they will be entirely displayed.
Theand buttons allow to manipulate the list as well.
If you display web pages, you might need to perform logins on the websites. Two possibilities can be used, depending on how the website authenticates you.
If the site uses HTTP authentication (usually a popup window asking for a login and password), the login and password have to be included in the URL:
Adding a RTSP network stream can display a video:
A local broadcast folder can be synchronised with an online cloud storage service (Dropbox, Google Drive, Apple iCloud, Microsoft One Drive, ...) allowing display content management via a cloud shared folder.
Adding a network folder can be done with Thunar file manager on the network by copying the files location's network address.
Or by entering manually the folder path :
Thebutton allows to program the screen sleep mode automatically.
Screen OFF - From: 20:00 TO: 08:00 0
If this option is selected, the data can be automatically updated when a USB key is inserted on the Linutop machine.
The data on the USB stick must follow some simple rules (). The files to display / play must be present at the root of the USB key (or in a folder with the name of the password of the remote control). The update is done automatically. Once the update is done the player will restart the display, then you can remove the key. Fixed elements can be added in addition to the local playlist.
If checked, the mouse pointer will disappear during slideshows.
If checked, the videos will not output sound.
This option run an external video player using full hardware acceleration. On OS XS (Raspberry Pi) this allows maximum video resolution of 1080p (video can't be stopped during playing),(Some HD videos might require more GPU memory to work properly and prevent a black screen). On PC, this option launch by default MPlayer and require adding acceleration software package. Other command line base hardware accelerators can be configured to accommodate other graphic cards.
You can use an external browser for maximum compatibility. The external browser must be configured in full screen. This option allows you to host an authentication to access a secure web page.
To use another web browser you have to edit this line in the kiosk configuration file (/etc/xdg/webkiosk/preferences)
"external_browser_cmd=chromium-browser --kiosk %u"
-kiosk triggers the kiosk option of the chromium browser (full screen)
%u passes the URL to the chromium browser
timming between two playlist update on Linutop TV
Plays items in random order.
Delay (in seconds) to use as default time for added items the static playlist.
This feature allows the user to directly interact with the playlist. It can also be used to display a message with the direct display feature.
To enable the remote, remote activation has to be checkedm then to start the remote, the Linutop Launcher must be running.
Once started, the remote is a web page accessible from any devices, such as smartphone, tablet, PC's web browser connected on the same network.
The remote web address can be seen in blue below the remote activation checkbox. Just copy the URL web dress in any browser to display it.
Note: The remote is available only when the linutop-kiosk software is running
It can also be directly displayed on the same screen as the player by clicking on the right mouse button.
Direct display allows to send a text message on the screen, it also returns a copy of the screen.
You can also directly display an item using the drag and drop menu below
The direct display template can be customized using the buttonin the Linutop kiosk settings menu.
You also have the option to change templates. By clicking on the button "change the template", you can select your template, then you must validate your selection. To display a message from the remote control, it should be explained in the template by the class "editable-block" and the variable "id = text".
By default, the template will be displayed. The "Direct template" allows you to have an editable graphic template with insertion of a live text.
This template allows you to display a graphic logo, the time, the date of the day and your message for a lobby.
Template: for a bus station, a pier and a small airfield. It can display a message via a web browser from a phone or tablet on the local network.
Note: The background image of these templates is available by clicking on the icons. It is composed of an image of 1920x1080 able to accommodate any images and include the modifiable text.
You can also create your own template to suit your preferences. This is a simple HTML file, it is very easy to edit.
For this, you just need to edit this template by keeping this lines, to be able to display the direct text.
<span id="text" style="font-size:5.7em"></span></span>
Linutop TV is an online digital signage service. It will automatically send to the Linutop Kiosk a playlist and its associated documents remotely.
Configuration of your display system is done in 3 steps:
Upload your files on Linutop TV. With the Linutop TV library interface you can upload your files (videos, images or URLs).
Create your display playlist. Organize your files and set up their display parameters.
Display your playlist. Connect your display screens to your Linutop TV account.
Linutop.tv can be accessed from any PC or web browser.
Linutop.tv is also available as a Private server, for more informations: www.linutop.tv
Thetab of the setup interface lets you define which proxy to use.
As shown on the screenshot, URI, user name and password can be defined.
User name and password entries can be left blank if your proxy doesn't require authentication.
The URI can take two forms:
Can display on several screens on the same network from linutop.TV broacast management server. on a local network or via Internet.
Can Linutop Kiosk play HD video?
- Yes Linutop Kiosk plays HD video depending on you hardware.
My screen is black nothing to display?
- Linutop Kiosk has nothing to display, your playlist is empty or the document cannot be reached.
My screen is in sleep mode?
- Linutop Kiosk is in sceen off mode to quit press 'ESC' key or CTRL+Q or Double click on mouse wheel.
How do I quit the linutop Kiosk in full screen ?
-To quit Linutop Kiosk press 'ESC'key or CTRL+Q or Double click on mouse wheel.
Can we use Linutop Kiosk as an Audio player ?
- Yes Linutop Kiosk play any audio files.
Storage of parameters for buster and 18.04 to the operating mode of the Kiosk:
This script is used to automatically broadcast the contents of a directory on a local network in order to synchronized the media on all players. It is a light broadcast server for players. Each player is configured to display the contents of the synchronized directory.
1. Get the IP address of your other machines
The "About" tab of the control panel allows you to have more info
In the Network section, you can retrieve the IP address of the current machine.
2. Create the main directory containing the items to be copied
In this part, you just have to create the directory containing the files to broadcast.
3. Open and edit the script according to your preferences (all information is in comment), here is the download link of the script: auto-synchro.sh.
4. Save the script, go to the "Start Application" section of the Linutop Control Panel.
In the command to enter just type: "bash /path/to/script.sh"
You must commit the changes and restart the system for the script to start at startup
5. Configuring the player to display the contents of the synchronized directory
Just add the directory to your local playlist
You can distribute as many documents on as many machines as you want.
The set of applications displaying specific files can be configured in the main configuration file (/etc/xdg/webkiosk/preferences). The association between files and applications is done using mime types, in a [mimetypes] section.
Simple exemple of file associations:
[mimetypes] application/pdf = evince
When using the local playlist to define the slideshow (no XML), the application will guess the type of each item to display using the protocol and file extension. If not correctly detected, the default behaviour is to display the item as a web page. To override this behaviour, you can associate filename extensions with display types.
The known types are:
The association is done in the main configuration file (/etc/xdg/webkiosk/preferences), in a [slideshow-types] section. For exemple:
[slideshow-types] iso = video flv = video gif = image
Scripts can be executed when some event happen on the kiosk. For each hook a different script must be used. The scripts just need to be named like the event, and to be executable. The scripts must be saved in the hook dir (/etc/xdg/webkiosk/hooks/).
The current events are:
In Kiosk mode, a prestart script can be used to define whether a web session should be triggered when the kiosk application starts. It can obviously also setup a few things before the application startup.
The prestart script is /etc/xdg/webkiosk/prestart. It will be used if it exists and is executable.
If the script returns 0, a web session will be triggered at startup. Any other return code will start the kiosk in display mode.
The browser offers a DBus interface, allowing to control a few things.
The DBus interface listens signals sent on the system bus on the object /com/linutop/WebKiosk. The messages are:
dbus-send can be used to send the signals:
# stop the current session dbus-send --system /com/linutop/WebKiosk com.linutop.WebKiosk.Signal.StopSession # add 2 minutes to the timer dbus-send --system /com/linutop/WebKiosk com.linutop.WebKiosk.Signal.AddTime uint32:120
The Linutop Kiosk can use an XML file to define multiple playlists, managed by a scheduler. It is possible to manually create these files.
The scheduler uses
loop blocks to define the various
playlists. Each loop must have an
(0 being reserved for the default playlist). A single loop
will contain the list of the items to displays:
<schedule> <loop id="0"> <item uri="http://www.google.com" time="10" /> <item uri="http://my_server/display/an_image.png" type="image" time="5" /> <item uri="http://my_server/display/a_video.avi" type="video" /> <item uri="http://my_server/display/an_image_as_web_page" time="5" /> <item uri="http://my_server/display/a_video_as_web_page" /> </loop> </schedule>
The previous example shows the definition of a basic playlist. The <schedule> and <loop> nodes are mandatory. The "id" attribute is also mandatory.
Each item must define an
uri" attribute which indicates where
the item can be found. It can use several schemes, depending on the type attribute:
will show a web page (the
must be omitted)
typeattribute is present, the webkiosk will download the file, and display it as a local file (the file is cached, and redownloaded only if needed).
typeattribute is missing, the uri will be used as if it were a web page (no cache).
The two supported types are image and video.
for URLs and images a
time attribute must be defined. It
stores the number of seconds that the item should be displayed. For videos,
the next item will be displayed when the video has ended.
http://for HTTP access (web server)
ftp://for FTP access
file://for file access
Authentication is supported. For example, using a FTP authentication in a URI would give:
Several loops can be defined. Each loop must have a uniq ID, and must define a time period. The loop ID'ed 0 will be the default loop, used if other loops don't match the current date/time.
Here are some examples of loops describing the schedule options:
<schedule> <loop id="0"> <!-- default playlist defined here --> </loop> <loop id="1" start="14:00" end="18:15"> <!-- this playlist will be read every day between 14:00 and 18:15 --> </loop> <loop id="2" start="14:00" end="18:15" weekdays="0246"> <!-- this playlist will be read every monday, wednesday, friday and sunday between 14:00 and 18:15 --> </loop> <loop id="3" start="2011/03/25 00:00"> <!-- this playlist will be used starting on march the 25th of 2011 --> </loop> <loop id="4" start="20:00" end="06:00" idle="1"> <!-- this playlist is marked as idle. This will shut down the screen of the client --> </loop> </schedule>
Combinations of these examples can be used.
Additionnal fonts can be necessary to display some web pages or documents.
It is possible to add new fonts to the system using a font file (fontname.ttf), to do so you need to create a folder with the name of the font in lower case in /usr/share/font then copy the fontname.ttf file into the folder. There is two way to do so, using thunar as root :
$ sudo thunarOr doing it with in command line (open the terminal in the folder containing the .ttf file):
$ sudo mkdir /usr/share/font/fontname $ sudo cp fontfile.ttf /usr/share/font/fontname/fontname.ttf
By default thunar can access your network. to secure/prevent this network access, use the command below.
$ sudo chmod 000 /usr/share/gvfs/mounts/network.mountAnd if you want to put it back:
$ sudo chmod 644 /usr/share/gvfs/mounts/network.mountYou need to restart your computer in order to apply the change.
This section explain how to setup a secure kiosk.
First you need to select Web Kiosk in the main panel and to check fullscreen and use a password (don't forget to set the password).
Then in the Web Kiosk tab you can choose which website will be displayed as home and in each new tab. Also you can blacklist or whitelist website using the restriction panel. Once done hit the OK button to validate the configuration.
Once secured to quit the kiosk application hit Ctrl+q and enter your password.
This section explains how to display a web page. It can be a local web page, Internet or intranet.
This can automatically display:
Select Dynamic Display Player to automatically run at startup and check "Run kiosk on startup
Then, in the Dynamic View Player tab, you must use the Add button to open a dialog box that allows you to choose which webpage to display and its display time, a time of 0 means it will be posted forever.
Once you have clicked the "web page" button, the browser (chromium or firefox will open), allowing you to access the desired page and copy its address in "Location URI" then validate
You can also activate the auto scrolling option so that a web page can be read in its entirety.
A zoom factor adjusts the text size for playback via the "Kiosk Web Browser" tab
Linutop Kiosk is available in theMenu
A local address can also be inserted "http://192.168.200.48/production/l1"
The default browser is the kiosk (based on WebKit, faster but can have a different rendering), it is possible to select an external browser by checking the option and allow the opening of Chromium, Firefox or other allowing accommodate the latest standards and strong authentication.
This configuration simply displays the contents of a shared directory containing photos, video, pdf on a screen.
In order to display the contain of a shared directory on a local network with or without password.
You must :
1- Access your shared directory with Thunar File Manager.(Acessories Menu)
2- Enter authentication to access the shared directory.
3- Open a dialog by pressing the Add button of the "Dynamic Display Player" interface.
4- Copy the path and insert it in the "Location URI" dialog box.
In case you want to add a password you have to go to "Browse the network", choose the network and then choose the option "Remember forever".
The "Test" button is not functional when you insert a shared directory.
This section explain how to use the Linutop TV service.
First you need to select Media Player in the main panel and if you want it to start automaticaly check the associated parameter.
If you use a public server you need to selectand to log with your invoice number and you password. Then choose the playlist you want to display and hit the button.
To quit the kiosk application hit Esc. If a password is set, use Ctrl+q and enter your password instead.
If you use a private server you need to selectand to check then enter the url or ip address of your server. once done you need to use your login and password to access the playlist (by default admin/linutop). Then choose the playlist you want to display and hit the button.
To quit the kiosk application hit Esc. If a password is set, use Ctrl+q and enter your password instead.