{"id":19501263,"url":"https://github.com/acryps/kiosk","last_synced_at":"2026-05-15T06:41:38.488Z","repository":{"id":223644060,"uuid":"761118801","full_name":"acryps/kiosk","owner":"acryps","description":"Kiosk Launcher","archived":false,"fork":false,"pushed_at":"2024-04-12T07:47:16.000Z","size":207,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-08T10:14:36.983Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acryps.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-21T09:21:40.000Z","updated_at":"2024-03-28T10:44:40.000Z","dependencies_parsed_at":"2024-04-12T09:02:44.852Z","dependency_job_id":null,"html_url":"https://github.com/acryps/kiosk","commit_stats":null,"previous_names":["acryps/kiosk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acryps%2Fkiosk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acryps%2Fkiosk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acryps%2Fkiosk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acryps%2Fkiosk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acryps","download_url":"https://codeload.github.com/acryps/kiosk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240749035,"owners_count":19851392,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T22:12:03.444Z","updated_at":"2026-05-15T06:41:38.446Z","avatar_url":"https://github.com/acryps.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @acryps/kiosk\nKiosk watcher for embedded browsers.\n\nUses puppeteer to launch a chromium window in kiosk mode, then makes sure that the page can be loaded.\n\nExample usage in a start script\n```\n#!/bin/sh\n\n# set active display\nexport DISPLAY=:0\n\n# install the latest version on startup\nnpm install --global @acryps/kiosk@latest\n\n# show the cloud page\nkiosk https://acryps.com/cloud --some-chrome-option\n```\n\nAdd a `window.kioskAlive()` function to your website, which will be called every second to ensure that the page is working.\nThe page will be reloaded if the function returns an error or a non `true` value.\nThe function is not awaited, it must return a value immediately.\n\nThe screen will turn dark gray if the health check failed and the page is trying to reload.\n```\n// just make sure that the page loaded\n(globalThis as any).kioskAlive = () =\u003e true;\n\n// fail if the network connection is broken\n(globalThis as any).kioskAlive = () =\u003e navigator.onLine;\n\n// fail when the first unhandled error occurs\nwindow.onerror = () =\u003e {\n\tdelete (globalThis as any).kioskAlive;\n};\n```\n\n## Full setup guide\nThe listed guides have been tested by us when we set up kiosks on different platforms. Install the OS and then execute the script over SSH or in the terminal **as the root user**. \n\n- [Raspberry Pi](setup/raspberry-pi)\n- [Debian with LXDE](setup/debian/lxde)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facryps%2Fkiosk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facryps%2Fkiosk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facryps%2Fkiosk/lists"}