{"id":20489617,"url":"https://github.com/telus/kiosk-controller","last_synced_at":"2025-05-09T04:31:55.720Z","repository":{"id":35273340,"uuid":"39534048","full_name":"telus/kiosk-controller","owner":"telus","description":"CLI and HTTP API to remotely control Chromium","archived":false,"fork":false,"pushed_at":"2016-02-10T16:47:23.000Z","size":21,"stargazers_count":1,"open_issues_count":0,"forks_count":7,"subscribers_count":7,"default_branch":"master","last_synced_at":"2023-03-01T13:56:45.325Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-22T22:51:27.000Z","updated_at":"2022-08-08T12:56:14.000Z","dependencies_parsed_at":"2022-08-08T14:15:15.841Z","dependency_job_id":null,"html_url":"https://github.com/telus/kiosk-controller","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkiosk-controller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkiosk-controller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkiosk-controller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkiosk-controller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telus","download_url":"https://codeload.github.com/telus/kiosk-controller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224816193,"owners_count":17374684,"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-15T17:13:32.791Z","updated_at":"2024-11-15T17:13:33.443Z","avatar_url":"https://github.com/telus.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Kiosk Controller\n================\n\n[![Code Climate](https://codeclimate.com/github/telusdigital/kiosk-controller/badges/gpa.svg)](https://codeclimate.com/github/telusdigital/kiosk-controller)\n\nA CLI app and HTTP API to remotely control Chromium or Midori running in a kiosk mode.\n\nOriginally built for opening dashboards on TV-connected Raspberry Pis.\n\n**NOTE**: Since starting Chromium spawns multiple processes (and possibily stops the initial one stored in shell variable `$!`), I was unable to find a reliable way to target a single window/tab. As a result, `kiosk` terminates all chromium processes before creating a new one when (re)starting.\n\n**NOTE**: This app assumes that the X Server is running on display `:0`, which allows the CLI to open the browser correctly in a console and over SSH.\n\n## Dependencies\n\nKiosk Controller requires: `chromium-browser`, `midori`, and `python3`. Running any `./kiosk` command will let you know if they are missing.\n\n## CLI\n\nRun `./kiosk help` for a list of available commands.\n\n## HTTP API\n\nBy default, kiosk will start an HTTP API. A HTTP header of 'kiosk-auth' will be needed if you set an API password using the CLI.\n\n**`GET / ` - Current status**\n\nReturns the plain text of the currently set page.\n\n**`POST /` - Temporarily change page**\n\nIf a HTTP header `kiosk-page` is specified, the page will be temporarily changed and the browser will restart.\n\nOtherwise, the browser will restart with the default page.\n\n**`PUT / ` - Permanently change page**\n\nIf a HTTP header `kiosk-page` is specified, the page will be saved as the new default and the browser will restart.\n\nOtherwise, if no page is specified, an HTTP 400 is returned.\n\n##Todo\n\n- Code review\n\n##Ideas\n\n- An iframe + sockets based page could get around the chromium control issues. The CLI could hook into a server sending messages to the client to switch the page, reload it, etc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelus%2Fkiosk-controller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelus%2Fkiosk-controller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelus%2Fkiosk-controller/lists"}