{"id":28392778,"url":"https://github.com/zetxtech/websole","last_synced_at":"2026-02-06T04:02:54.921Z","repository":{"id":250617350,"uuid":"834953368","full_name":"zetxtech/websole","owner":"zetxtech","description":"Websole is a web-based console for you to expose command-line tools to a web server.","archived":false,"fork":false,"pushed_at":"2024-07-28T20:10:09.000Z","size":227,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-12T21:39:53.355Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"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/zetxtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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-07-28T20:02:47.000Z","updated_at":"2024-07-28T20:19:49.000Z","dependencies_parsed_at":"2024-07-28T21:58:45.411Z","dependency_job_id":null,"html_url":"https://github.com/zetxtech/websole","commit_stats":null,"previous_names":["zetxtech/websole"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zetxtech/websole","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwebsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwebsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwebsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwebsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zetxtech","download_url":"https://codeload.github.com/zetxtech/websole/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwebsole/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29149594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T02:39:25.012Z","status":"ssl_error","status_checked_at":"2026-02-06T02:37:22.784Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-05-31T15:08:15.190Z","updated_at":"2026-02-06T04:02:54.856Z","avatar_url":"https://github.com/zetxtech.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Websole\n\nWebsole is a web-based console for you to expose command-line tools to a web server.\n\n## Features\n\n1. Protect your terminal with a login password.\n2. Customizable logos, links, and icons.\n3. Simple to use as a base docker image in other projects.\n\n## Screenshot\n\n\u003cimg src=\"https://github.com/zetxtech/websole/raw/main/images/example_console.png\" alt=\"console page\" width=\"600\"/\u003e\n\n\u003cimg src=\"https://github.com/zetxtech/websole/raw/main/images/example_login.png\" alt=\"login page\" width=\"600\"/\u003e\n\n## Install\n\nYou can expose any program (for example, `bash`) by running:\n\n```bash\ndocker run -p 80:1818 --rm -it jackzzs/websole:main bash\n```\n\nThis will expose a terminal running `bash` on port 80.\n\n# Use in other projects\n\nYou can use websole as a base docker image, to expose your program.\n\nSee the `examples` [directory](https://github.com/zetxtech/websole/tree/main/examples) for examples.\n\n# Commandline options\n\n```\nUsage: websole [OPTIONS] COMMAND\n\n    --host              Host for web console to listen on (default: 127.0.0.1).\n    --port              Port for web console to listen on (default: 1818).\n    --webpass           Password for logging into the web console (default: \u003cno password\u003e).\n    --brand             Brand to be shown in web console header (default: Web Console).\n    --icon              Add an icon to be shown in web console footer (format: \u003cicon\u003e:\u003curl\u003e).\n    --link              Add a link to be shown in web console footer (format: \u003clabel\u003e:\u003curl\u003e).\n    --config            Location of the config file (default: websole.yml).\n    --start/--no-start  Whether to start the program immediately, rather than on first connection. (default: False)\n    --version           Print version and exit.\n    --help              Show help message and exit.\n\nNOTE: If COMMAND contains spaces, you need to enclose it in quotes.\n```\n\n# Configuration file\n\nDefault config:\n```yaml\n# Program to be exposed to web console.\ncommand: bash\n\n# Host for web console to listen on.\nhost: 0.0.0.0\n\n# Port for web console to listen on.\nport: 1818\n\n# Brand to be shown in web console header.\nbrand: Your Program\n\n# Link to be shown in web console footer.\nlinks:\n  - label: Github\n    url: https://github.com/zetxtech/websole\n  - label: Example\n    url: https://websole.onrender.com\n\n# Icons to be shown in web console footer.\n# icon names can be found from https://icons.getbootstrap.com/\nicons:\n  - icon: bi-github\n    url: https://github.com/zetxtech/websole\n  - icon: bi-fire\n    url: https://websole.onrender.com\n\n# Password for logging into the web console.\nwebpass: 123456\n\n# Whether to start the program immediately, rather than on first connection.\nstart: yes\n\n# URL for \"What is web console password?\" link on the login page.\nwhat_is_webpass_url: https://github.com/zetxtech/websole\n\n# Allow users to restart the program through the refresh button in the upper right corner of the console.\nallow_restart: yes\n\n# By default, allow users to use Ctrl+C/V to copy/paste (but prevent the shortcut key from reaching the program).\nuse_shortcut: no\n\n# Hide the switch for \"use Ctrl+C/V to copy/paste\".\nhide_use_shortcut_switch: no\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzetxtech%2Fwebsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzetxtech%2Fwebsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzetxtech%2Fwebsole/lists"}