Select the version of your OS from the tabs below. If you don't know the version you are using, run the command cat /etc/os-release or cat /etc/issue on the board.
Remember that you can always refer to the Torizon Documentation, there you can find a lot of relevant articles that might help you in the application development.
The Torizon Chromium and Cog browser containers run a browser in kiosk-mode, allowing the implementation of web-based UIs for kiosk applications.
These containers should be used together with the torizon/weston (iMX6/iMX7) or torizon/weston-vivante (iMX8) containers to provide a kiosk-mode user interface with a browser that opens an URL passed as a parameter, does not show error messages/popups and does not allow the user to navigate to different websites.
It is a full-screen mode where only the web page is displayed. The user cannot see the window, the top bar, refresh button, or anything else.
Torizon provides support for Chromium and Cog.
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web. In the Chromium container, Chromium uses Ozone/Wayland as a rendering backend. As of torizon/chromium:2.6.0, GPU acceleration is enabled.
Cog is a single "window" launcher for the WebKit WPE port. It is small, provides no user interface, and is suitable to be used as a Web application launcher. Cog is able to leverage the GPU for hardware-accelerated applications, which works well on iMX6 and iMX8 based modules. From Cog container with the container tag 2.6 onwards, Cog is supported also on devices that lack a GPU (e.g. iMX7 and iMX6ULL).
This article complies to the Typographic Conventions for Torizon Documentation.
Start the Wayland server container (torizon/weston or torizon/weston-vivante) to provide the graphical environment for the browser window:
(Optional) pull the torizon/weston container image:
# docker pull torizon/weston:$CT_TAG_WESTON
Start the weston compositor:
# docker run -d --rm --name=weston --net=host --cap-add CAP_SYS_TTY_CONFIG \
-v /dev:/dev -v /tmp:/tmp -v /run/udev/:/run/udev/ \
--device-cgroup-rule='c 4:* rmw' --device-cgroup-rule='c 13:* rmw' \
--device-cgroup-rule='c 199:* rmw' --device-cgroup-rule='c 226:* rmw' \
torizon/weston:$CT_TAG_WESTON --developer weston-launch --tty=/dev/tty7 --user=torizon
(Optional) pull the torizon/weston container image:
# docker pull torizon/weston:$CT_TAG_WESTON
Start the weston compositor:
# docker run -d --rm --ipc=host --name=weston --net=host --cap-add CAP_SYS_TTY_CONFIG \
-v /dev:/dev -v /tmp:/tmp -v /run/udev/:/run/udev/ \
--device-cgroup-rule='c 4:* rmw' --device-cgroup-rule='c 13:* rmw' \
--device-cgroup-rule='c 199:* rmw' --device-cgroup-rule='c 226:* rmw' \
torizon/weston:$CT_TAG_WESTON --developer weston-launch \
--tty=/dev/tty7 --user=torizon -- --use-pixman
(Optional) pull the torizon/weston-vivante container image:
# docker pull torizon/weston-vivante:$CT_TAG_WESTON_VIVANTE
Start the weston compositor:
Attention: Please, note that by executing the following line you are accepting the terms and conditions of the NXP's End-User License Agreement (EULA)
# docker run -e ACCEPT_FSL_EULA=1 -d --rm --name=weston --net=host --cap-add CAP_SYS_TTY_CONFIG \
-v /dev:/dev -v /tmp:/tmp -v /run/udev/:/run/udev/ \
--device-cgroup-rule='c 4:* rmw' --device-cgroup-rule='c 13:* rmw' \
--device-cgroup-rule='c 199:* rmw' --device-cgroup-rule='c 226:* rmw' \
torizon/weston-vivante:$CT_TAG_WESTON_VIVANTE --developer weston-launch \
--tty=/dev/tty7 --user=torizon
To learn more about it, read the article Debian Containers for Torizon to provide the graphical environment for the browser window.
Moreover, depending on how your application is designed, also start a container that provides the local UI that the kiosk browser will render.
Note: If you are running Torizon 5.6.0 or earlier, see Running Chromium on Torizon 5.6.0 and earlier.
The Chromium container needs visibility to some host resources (for accessing the accelerated graphical environment, buffer sharing, and inter-process communication), and the URL of the web UI as a command-line parameter. It also recognizes some optional command-line flags (explained ahead).
You can run the following command to start the Chromium container:
# docker run -eMACHINE -d --rm --name=chromium \
-v /tmp:/tmp -v /dev/dri:/dev/dri \
-v /var/run/dbus:/var/run/dbus --device-cgroup-rule='c 226:* rmw' \
--security-opt seccomp=unconfined --shm-size 256mb \
torizon/chromium:$CT_TAG_CHROMIUM \
--virtual-keyboard https://www.toradex.com
# docker run -eMACHINE -d --ipc=host --rm --name=chromium \
-v /tmp:/tmp -v /dev/dri:/dev/dri -v /var/run/dbus:/var/run/dbus \
--device-cgroup-rule='c 226:* rmw' --shm-size="256m" \
--security-opt="seccomp=unconfined" \
torizon/chromium-x11:$CT_TAG_CHROMIUM_X11 \
--virtual-keyboard https://www.toradex.com
# docker run -eMACHINE -d --rm --name=chromium \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
-v /dev/galcore:/dev/galcore --device-cgroup-rule='c 199:* rmw' \
--security-opt seccomp=unconfined --shm-size 256mb \
torizon/chromium:$CT_TAG_CHROMIUM \
--virtual-keyboard https://www.toradex.com
It's possible to start Chromium in less-secure ways (secure from the point of view of a user being able to run other graphical apps etc.) using command line switches.
--window-mode : runs the browser inside a maximized window without the navigation bar--browser-mode : runs the browser in a standard window with navigation bars and all user menus enabled--virtual-keyboard : enables a virtual keyboard for text entryBy default Chromium runs with GPU hardware acceleration for all devices except iMX7 and iMX6ULL. Following flags affect this feature:
--disable-gpu-compositing : Disables GPU compositing only. May increase performance for some applications at the cost of increased CPU utilization. Reduces the performance of WebGL applications.--disable-gpu : Disables GPU hardware acceleration completely.Note: If you are running Torizon 5.6.0 or earlier, see Running Cog on Torizon 5.6.0 and earlier.
You can run the following command to start the Cog container:
# docker run -d --rm --name=cog \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
-v /dev/dri:/dev/dri --device-cgroup-rule='c 226:* rmw' \
torizon/cog:$CT_TAG_COG \
https://www.toradex.com
# docker run -d --rm --name=cog \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
-v /dev/galcore:/dev/galcore --device-cgroup-rule='c 199:* rmw' \
torizon/cog:$CT_TAG_COG \
https://www.toradex.com
To change how the output will be configured, the following environment variables can be set:
--env COG_PLATFORM_WL_VIEW_FULLSCREEN--env COG_PLATFORM_WL_VIEW_MAXIMIZE--env COG_PLATFORM_WL_VIEW_WIDTH--env COG_PLATFORM_WL_VIEW_HEIGHTBy default video playback does not work with the above container image. You'll need to customize or build a new container image in order to have video playback. For this you'll need to perform the following steps:
GST_GL_API=gles2.After these customizations, you can then launch this new container with the same arguments as shown above. But now the container should be able to playback videos, like on Youtube for example.
Docker compose can be used to start multiple containers at the same time, providing shared data volumes, mount points, resource usage limitations, etc. If you want to use Chromium or Cog container in this way it's a good idea to make it dependent on the Wayland compositor container and the container providing the data that should be displayed by the UI.
You can find example Docker compose files in our sample repository: https://github.com/toradex/torizon-samples/tree/bullseye/debian-container/demonstration
The previously described command line flags must be added to the command parameter on the docker-compose file. See an example in the code snippet below:
docker-compose.ymlservices: kiosk: command: --virtual-keyboard --window-mode http://portainer:9000
The TorizonCore with Evaluation Containers image comes with the Chromium container, since we run the Portainer container manager on top of it. You can read or edit the file on the board on /var/sota/storage/docker-compose/docker-compose.yml for quick evaluation. To make persistent changes or deploy your own docker-compose.yml, we recommend using the TorizonCore Builder Tool.
In the article Using Multiple Containers with TorizonCore, we use the Chromium container to display Grafana on a local UI. It allows us to explain, with a practical example, how to use multiple containers on Torizon.
Remote access via VNC
As the image above illustrates, you can remote access the Weston container via VNC or RDP, please refer to the Remote Access the TorizonCore GUI Using VNC or RDP to learn more.
In Torizon 5.6.0 and earlier, there is only one container for both Chromium and COG.
The kiosk container needs visibility to some host resources (for accessing the accelerated graphical environment, buffer sharing, and inter-process communication), and the URL of the web UI as a command-line parameter. It also recognizes some optional command-line flags (explained ahead).
You can run the following command to start the kiosk-mode browser container with Chromium:
# docker run -d --rm --name=kiosk \
-v /tmp:/tmp -v /dev/dri:/dev/dri \
-v /var/run/dbus:/var/run/dbus --device-cgroup-rule='c 226:* rmw' \
--security-opt seccomp=unconfined --shm-size 256mb \
torizon/kiosk-mode-browser:$CT_TAG_KIOSK_MODE_BROWSER \
--virtual-keyboard https://www.toradex.com
# docker run -d --rm --name kiosk \
--ipc=host -v /tmp:/tmp -v /dev/dri:/dev/dri -v /var/run/dbus:/var/run/dbus \
--device-cgroup-rule='c 226:* rmw' --shm-size="256m" \
--security-opt="seccomp=unconfined" \
torizon/kiosk-mode-browser-x11:$CT_TAG_KIOSK_MODE_BROWSER_X11 \
--virtual-keyboard https://www.toradex.com
# docker run -d --rm --name=kiosk \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
--security-opt seccomp=unconfined --shm-size 256mb \
torizon/kiosk-mode-browser:$CT_TAG_KIOSK_MODE_BROWSER \
--virtual-keyboard https://www.toradex.com
It's possible to start Chromium in less-secure ways (secure from the point of view of a user being able to run other graphical apps etc.) using command line switches.
--window-mode : runs the browser inside a maximized window without the navigation bar--browser-mode : runs the browser in a standard window with navigation bars and all user menus enabled--virtual-keyboard : enables a virtual keyboard for text entryYou can run the following command to start the kiosk-mode browser container with Cog:
# docker run -d --rm --name=kiosk \
--env KIOSK_LAUNCHER=cog \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
-v /dev/dri:/dev/dri --device-cgroup-rule='c 226:* rmw' \
torizon/kiosk-mode-browser:$CT_TAG_KIOSK_MODE_BROWSER \
https://www.toradex.com
# docker run -d --rm --name=kiosk \
--env KIOSK_LAUNCHER=cog \
-v /tmp:/tmp -v /var/run/dbus:/var/run/dbus \
-v /dev/galcore:/dev/galcore --device-cgroup-rule='c 199:* rmw' \
torizon/kiosk-mode-browser-vivante:$CT_TAG_KIOSK_MODE_BROWSER \
https://www.toradex.com
Warning: For version 5.6.0 and earlier, Cog is not supported on iMX7 and iMX6ULL based modules.
Container that can be used to run a browser in kiosk-mode, allowing implementation of web-based UIs.
This container should be used together with the torizon/arm32v7-debian-weston:buster container to provide a kiosk-mode user interface with a browser that opens an URL passed as a parameter, does not show error messages/popups and does not allow the user to navigate to different websites.
Current implementation is based on chromium (using ozone/wayland rendering backend).
This article complies to the Typographic Conventions for Torizon Documentation.
You should start the wayland server container first (torizon/arm32v7-debian-weston:buster) and the container providing the local UI, if required. When you start the kiosk container you need to provide access to the /tmp folder (used for wayland and X11 sockets), /dev/dri (for buffer sharing/hardware acceleration) and provide the URL you want to open as command line parameter.
# docker run -d --rm -v /tmp:/tmp -v /dev/dri:/dev/dri -v /var/run/dbus:/var/run/dbus \
--device-cgroup-rule='c 226:* rmw' --shm-size="256m"
--security-opt="seccomp=unconfined" \
torizon/arm32v7-debian-kiosk-mode-browser https://www.toradex.com
Replace arm32v7 with arm64v8 for the 64-bit variant.
For the X11 build we have to provide shared memory access from the host system:
# docker run -d --ipc=host --rm -v /tmp:/tmp -v /dev/dri:/dev/dri -v /var/run/dbus:/var/run/dbus \
--device-cgroup-rule='c 226:* rmw' --shm-size="256m"
--security-opt="seccomp=unconfined" \
torizon/arm32v7-debian-kiosk-mode-browser https://www.toradex.com
It's possible to start chromium in less-secure ways (secure from the point of view of user being able to run other graphical apps etc.) using command line switches.
Docker compose can be used to start multiple containers at the same time, providing shared data volumes, mount points, resource usage limitations etc. If you want to use the kiosk-mode-browser container in this way it's a good idea to make it dependent from the Wayland compositor container and the container providing the data that should be displayed by the UI.
You can find example Docker compose files in our sample repository: https://github.com/toradex/torizon-samples/tree/master/debian-container/demonstration
