PIXILAB Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
blocks:porteus_kiosk [2023-02-09 12:35]
mattias [Config to use to enable Offline/Block caching mode of the Pixilab Player.] 		blocks:porteus_kiosk [2024-02-09 12:43] (current)
admin player 6.3
Line 1: Line 1:
-====== PIXILAB Player ======+====== PIXILAB Player advanced setup======
  
-PIXILAB Player is free software that makes a browser-based player or interactive kiosk out of an Intel NUC or other PC-style computer, for use as a Display Spot for Blocks. It's based on an enhanced version of the excellent [[http://porteus-kiosk.org/|Porteus Kiosk]] open source project.+PIXILAB Player is free software that makes a browser-based player or interactive kiosk out of an Intel NUC or other PC-style computer, for use as a Display Spot for Blocks. It's based on an enhanced version of the excellent [[http://porteus-kiosk.org/|Porteus Kiosk]] project.
  
 This is how it works: This is how it works:
Line 12: Line 12:
   * Restart the computer.   * Restart the computer.
  
-This guide describes in detail how you can make a player for use as a Display Spot with Blocks. We recommend using an [[https://www.intel.com/content/www/us/en/products/boards-kits/nuc/kits.html|Intel NUC]] as the player. For basic applications in HD resolution, you can choose a low-cost, Celeron based model. For most applications, an i3-based model is sufficient. For demanding applications, select an i5 or i7-based model. +This guide describes in detail how you can make a player for use as a Display Spot with Blocks. We recommend using an [[https://www.asus.com/business/nucs/nuc-kits/filter?Category=nuc-essential,nuc-pro&Series=NUC-Kits,NUC-Mini-PCsl|Asus Intel NUC]] or similar as the player hardware. For basic applications in HD resolution, you can choose a low-cost, Celeron based model. For most applications, an i3-based model is sufficient. For demanding applications, select an i5 or i7-based model. 
  
-The player only needs CPU and a minimum of 4 GB of RAM to be installed. No hard drive/SSD is required. For 4k video playback, //two// RAM modules are recommended to optimize the memory bandwidth. Most modern NUCs runs SO-DIMM at 2666Mhz – check manufacturers recommendations for details.+The player only needs CPU and a minimum of 4 GB of RAM to be installed. No hard drive/SSD is required. For 4k video playback, //two// matched RAM modules are recommended to optimize the memory bandwidth.
  
 ==== Obtaining the Installer ==== ==== Obtaining the Installer ====
  
-Start by downloading the ISO image of [[https://pixilab.se/outgoing/blocks/pixilab-player-221214-6.0.iso|PIXILAB Player version 6.0]]. This file needs to be copied to a USB stick using Etcher. Make sure your target computer can boot from a USB stick. Download [[https://www.balena.io/etcher/|Etcher]] and use it to copy the ISO image onto your USB memory stick.+Start by downloading the ISO image of [[https://pixilab.se/outgoing/blocks/pixilab-player-240209-6.3.iso|PIXILAB Player version 6.3]]. This file needs to be copied to a USB stick using Etcher. Make sure your target computer can boot from a USB stick. Download [[https://www.balena.io/etcher/|Etcher]] and use it to copy the ISO image onto your USB memory stick.
  
 More details on what's changed between versions in the [[blocks:porteus_kiosk:release_notes|PIXILAB Player release notes]]. More details on what's changed between versions in the [[blocks:porteus_kiosk:release_notes|PIXILAB Player release notes]].
Line 43: Line 43:
 {{ :blocks:porteus:porteus_proxy_settings.png?800;nolink |}} {{ :blocks:porteus:porteus_proxy_settings.png?800;nolink |}}
  
-Select which browser to use. We strongly recommend thay you select Google Chrome. Some features in Blocks require Chrome to work properly. +Select which browser to use. We strongly recommend that you select Google Chrome. Some features in Blocks require Chrome to work properly. 
  
 {{ :blocks:porteus:porteus_browser_selection.png?800;nolink |}} {{ :blocks:porteus:porteus_browser_selection.png?800;nolink |}}
Line 49: Line 49:
 A network connection will be established (this may take some time). If a license agreement is presented, read and agree to it. Your browser of choice will be downloaded. A network connection will be established (this may take some time). If a license agreement is presented, read and agree to it. Your browser of choice will be downloaded.
  
-At the next page, you have the choice of either doing all settings manually, or loading them in from a text file on a USB stick. The text file method is faster, while the manual method allows for greater flexibility in choosing the options you want. +On the next page, you have the choice of either doing all settings manually or loading them in from a text file on a USB stick. The text file method is faster, while the manual method allows for greater flexibility in choosing the options you want. 
  
 {{ :blocks:porteus:porteus_final_options.png?800;nolink |}} {{ :blocks:porteus:porteus_final_options.png?800;nolink |}}
Line 55: Line 55:
 === Automatic Configuration === === Automatic Configuration ===
  
-If you want to use the text file method (recommended), copy the text shown below to another FAT32-formatted USB stick. Put it at the root level of the USB stick, naming it to something you will recognise, i.e //kiosk-config.txt//.  +If you want to use the text file method (recommended), copy the text shown below to another FAT32-formatted USB stick. Put it at the root level of the USB stick, naming it to something you will recognize, i.e. //kiosk-config.txt//. 
-Version 6 standard config+
  
-===Config to use with Blocks from version 6 with pixilab player from version 6:===+ 
 +===Config to use with Blocks from version 6 with pixilab player from version 6===
 <code> <code>
 connection=wired connection=wired
Line 73: Line 73:
 persistence=session persistence=session
 timezone=Factory timezone=Factory
 +#If you experience graphic issues or hangups on older hardware, please change the gpu_driver parameter from "modesetting" to "default"
 +gpu_driver=modesetting
 primary_keyboard_layout=us primary_keyboard_layout=us
 kernel_parameters=panic=10 kernel_parameters=panic=10
Line 97: Line 99:
 </code> </code>
  
-====Config to use with legacy versions prior to version 6:====+===Config to use with legacy versions prior to version 6:===
  
 <code> <code>
Line 129: Line 131:
 </code> </code>
  
-Replace //MyWifiNetwork// and //$uperSecret// with your wifi network name and password. Note that when using wifi, you may not be able to turn your player //on// from Blocks, since that mechanism uses on Wake-on-LAN, which is rarely supported over wifi.+Replace //MyWifiNetwork// and //$uperSecret// with your wifi network name and password. Note that when using wifi, you may not be able to turn your player //on// from Blocks, since that mechanism uses Wake-on-LAN, which is rarely supported over wifi.
  
 To use a physical keyboard with the player, specify the desired layout using the //primary_keyboard_layout// parameter, specifying one of [[https://porteus-kiosk.org/files/keyboards.txt|these constants]].  To use a physical keyboard with the player, specify the desired layout using the //primary_keyboard_layout// parameter, specifying one of [[https://porteus-kiosk.org/files/keyboards.txt|these constants]]. 
Line 139: Line 141:
 </code> </code>
  
-=== Manual Configuration === 
- 
-If you choose to do the configuration manually, here are some options you most likely need to set. 
- 
-  * Enable Wake on LAN. 
-  * Enable Home Page, setting the url to ''http://pixi.guide/spot'' and selecting "Append string to the homepage: MAC address". 
-  * Private mode; disable. 
-  * Zoom Controls; disable. 
-  * Navigation bar; disable. 
-  * Mouse Cursor; Disable (with "Hide Permanently") if using a touch screen, else Enable. 
-  * The additional components mentioned above (uefi.zip pixilab.xzm), where pixilab.xzm provides custom functionality such as power management and improved reliability under some network conditions.  
  
-The second point above (as well as the //homepage// option in the config file) assumes that you have a DNS that resolves ''pixi.guide'' to your local Blocks server. If not, type the IP address (and possibly port number) of your server instead of ''pixi.guide''. Finally, press Next, which displays a "Setting report" with similar information as shown for the //kiosk-config.txt// file above. 
 ==== Disable Automatic Fixes ==== ==== Disable Automatic Fixes ====
  
Line 224: Line 214:
 ==== Manage Pixilab Player Chrome Policies from the Blocks server ==== ==== Manage Pixilab Player Chrome Policies from the Blocks server ====
  
-This section applies to Pixilab player versions < 5.2. From version 5.2 this is handled automatically.+This section applies to Pixilab player versions < 5.2. From version 5.2 this is handled automatically for the servers homepage.
  
-In some cases, when using the Chrome browser with PIXILAB Player, you may need to override the browser's policies. This can be done by storing a text file named chrome-policies.txt in the directory <your-blocks-root>/public/PIXILAB_Player (where "<your-block-root>" is the location of your Blocks root directory).The path to this file is then be specified in the kiosk-config.txt file used when creating the player the, as described above. This example assumes the default domain name //pixi.guide// (which in your case may be another domain name, or a hardcoded IP address).+In some cases, when using the Chrome browser with PIXILAB Player, you may want to override the browser's policies. This can be done by storing a text file named chrome-policies.txt in the directory <your-blocks-root>/public/PIXILAB_Player (where "<your-block-root>" is the location of your Blocks root directory).The path to this file is then be specified in the kiosk-config.txt file used when creating the player the, as described above. This example assumes the default domain name //pixi.guide// (which in your case may be another domain name, or a hardcoded IP address).
  
 <code>browser_preferences=http://pixi.guide/public/PIXILAB_Player/chrome-policies.txt</code> <code>browser_preferences=http://pixi.guide/public/PIXILAB_Player/chrome-policies.txt</code>