{"id":24432331,"url":"https://github.com/jdgregson/htoptty","last_synced_at":"2025-03-13T20:14:02.774Z","repository":{"id":273290146,"uuid":"919208369","full_name":"jdgregson/htoptty","owner":"jdgregson","description":"Run htop on a TTY.","archived":false,"fork":false,"pushed_at":"2025-01-20T02:22:10.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-20T02:41:42.842Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/jdgregson.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":"2025-01-20T00:38:41.000Z","updated_at":"2025-01-20T02:22:12.000Z","dependencies_parsed_at":"2025-01-20T02:41:45.314Z","dependency_job_id":"4198815b-a39f-44f5-94f3-9a5e78c00362","html_url":"https://github.com/jdgregson/htoptty","commit_stats":null,"previous_names":["jdgregson/htoptty"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdgregson%2Fhtoptty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdgregson%2Fhtoptty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdgregson%2Fhtoptty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdgregson%2Fhtoptty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jdgregson","download_url":"https://codeload.github.com/jdgregson/htoptty/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243475357,"owners_count":20296712,"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":"2025-01-20T15:38:57.662Z","updated_at":"2025-03-13T20:14:02.749Z","avatar_url":"https://github.com/jdgregson.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# htoptty: run htop on a TTY\n\n`htoptty` is a small script to run htop on a TTY, such as `/dev/tty7`. This can\nbe useful when you have a display connected to a device and want to securely run\nhtop on the display unsupervised, or want your VM manager to show htop output on\nall of your VM screens without having to log in.\n\n`htoptty` creates a no-login user to run htop and outputs directly to a TTY. The\nhtop instance does not accept any keyboard or mouse interaction of any kind and\nhas multiple layers of isolation separating the htop I/O from TTY I/O.\n\nThis repo provides a script to install `htoptty` and a systemd service.\n\n### Installation\n\nPrerequisites:\n- A Linux system with systemd (built on Ubuntu Server 22.04)\n- `htop` installed on the system\n- `curl` for downloading the `htoptty` script\n\nTo install `htoptty`, follow these steps:\n\nEasy (default config on TTY7):\n```bash\ncurl \"https://raw.githubusercontent.com/jdgregson/htoptty/refs/heads/master/setup.sh\" | sudo bash\n```\n\nCustom:\n1. Clone the repository to your local machine: `git clone https://github.com/jdgregson/htoptty.git`\n1. Navigate to the directory containing the `setup.sh` script: `cd htoptty`\n1. Make any needed config changes to `setup.sh`\n1. Make the setup script executable: `chmod +x setup.sh`\n1. Run the setup script with root privileges: `sudo ./setup.sh`\n\n## Using `htoptty`\n\n### Starting service\n```bash\nsystemctl start htoptty\n```\n\n### Stopping service\n```bash\nsystemctl stop htoptty\n```\n\n### Viewing htoptty output\n\nYou can view the htop output by changing your display to use the configured TTY\n(typically TTY1 or TTY7).\n\nOn systems such as Ubuntu, you can use `Crtl + Alt + F\u003cnum\u003e` locally to switch\nTTYs, where `\u003cnum\u003e` is a number between 1 and 7.\n\n## Configuration\n\nThe `setup.sh` script uses the following default configuration:\n\n```bash\nHTOP_COMMAND=\"htop -d 50 --no-mouse --sort-key PERCENT_CPU\"\nUSE_TTY=7\nSCRIPT_PATH=/usr/local/bin/htoptty\nUSE_USER=htoptty\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdgregson%2Fhtoptty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjdgregson%2Fhtoptty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdgregson%2Fhtoptty/lists"}