{"id":14338651,"url":"https://github.com/zyyzyykk/kkTerminal","last_synced_at":"2025-08-19T07:31:00.149Z","repository":{"id":200131527,"uuid":"704828551","full_name":"zyyzyykk/kkTerminal","owner":"zyyzyykk","description":"A terminal for Web SSH connection","archived":false,"fork":false,"pushed_at":"2024-12-16T06:16:33.000Z","size":51155,"stargazers_count":318,"open_issues_count":0,"forks_count":19,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-16T07:25:16.591Z","etag":null,"topics":["docker","sftp","shell","ssh","ssh-client","ssh-server","terminal","web","xterm","xterm-js"],"latest_commit_sha":null,"homepage":"https://ssh.kkbpro.com/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zyyzyykk.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-14T08:05:24.000Z","updated_at":"2024-12-16T06:16:37.000Z","dependencies_parsed_at":"2023-10-15T21:59:33.756Z","dependency_job_id":"dd55b3d4-e79c-4492-8bd0-8737af6b09bd","html_url":"https://github.com/zyyzyykk/kkTerminal","commit_stats":null,"previous_names":["zyyzyykk/kkterminal"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyyzyykk%2FkkTerminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyyzyykk%2FkkTerminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyyzyykk%2FkkTerminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyyzyykk%2FkkTerminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zyyzyykk","download_url":"https://codeload.github.com/zyyzyykk/kkTerminal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230328777,"owners_count":18209392,"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":["docker","sftp","shell","ssh","ssh-client","ssh-server","terminal","web","xterm","xterm-js"],"created_at":"2024-08-26T06:00:41.270Z","updated_at":"2025-08-19T07:31:00.028Z","avatar_url":"https://github.com/zyyzyykk.png","language":"Vue","funding_links":[],"categories":["Vue","终端工具"],"sub_categories":[],"readme":"# kkTerminal\n\n\u003e kkTerminal, a terminal for Web SSH connection\n\u003e\n\u003e Author: [zyyzyykk](https://github.com/zyyzyykk/)\n\u003e\n\u003e Source Code: https://github.com/zyyzyykk/kkTerminal\n\u003e\n\u003e Docker Hub Address: https://hub.docker.com/repository/docker/zyyzyykk/kkterminal/general\n\u003e\n\u003e Preview: https://ssh.kkbpro.com/\n\u003e\n\u003e Update Time: 2025-03-15\n\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://ssh.kkbpro.com/\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg width=\"100\" src=\"https://kkbapps.oss-cn-shanghai.aliyuncs.com/logo/terminal.png\" alt=\"kkTerminal\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://hub.docker.com/repository/docker/zyyzyykk/kkterminal/general\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/zyyzyykk/kkterminal?logo=docker\" alt=\"Docker Image\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.oracle.com/cn/java/technologies/downloads/#java8-windows\"\u003e\u003cimg src=\"https://img.shields.io/badge/jdk-1.8-orange?logo=openjdk\u0026logoColor=%23e3731c\" alt=\"JDK Version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://spring.io/projects/spring-boot\"\u003e\u003cimg src=\"https://img.shields.io/badge/springboot-2.7.15-green?color=6db33f\u0026logo=springboot\" alt=\"SpringBoot Version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://cn.vuejs.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/vue-3.x-green?color=42b883\u0026logo=vue.js\" alt=\"Vue Version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.apache.org/licenses/\"\u003e\u003cimg src=\"https://img.shields.io/badge/licence-Apache-red?logo=apache\u0026logoColor=%23D22128\" alt=\"Apache Licence\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zyyzyykk/kkTerminal\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/zyyzyykk/kkterminal\" alt=\"GitHub\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eEnglish ｜ \u003ca href=\"./doc/zh_CN/README.md\" \u003e简体中文\u003c/a\u003e\u003c/p\u003e\n\n### ⚡ Quick integration\n\nUsing the `iframe` tag in HTML web pages to quick integration:\n\n```html\n\u003ciframe src=\"https://ssh.kkbpro.com/\" height=\"400px\" width=\"600px\" \u003e\u003c/iframe\u003e\n```\n\n### 🐳 Deploy with Docker\n\n1. Pull image:\n\n```bash\ndocker pull zyyzyykk/kkterminal\n```\n\n2. Create and run a container for port mapping: `-p port:3000`\n\n```bash\ndocker run -d --name kkterminal -p 3000:3000 zyyzyykk/kkterminal\n```\n\n3. Custom art word: `-e TITLE=\"ArtWord\"`\n\n```bash\ndocker run -d --name kkterminal -p 3000:3000 -e TITLE=\"kkbpro\" zyyzyykk/kkterminal\n```\n\n4. Accessing in browser: `http://server-ip:3000/`\n\n### 🛸 Preview\n\nVisit the following website: https://ssh.kkbpro.com/\n\n![Connect](https://kkbapps.oss-cn-shanghai.aliyuncs.com/terminal/3.6.0/en/Connect.png)\n\n![Preference](https://kkbapps.oss-cn-shanghai.aliyuncs.com/terminal/3.6.0/en/Preference.png)\n\n![File](https://kkbapps.oss-cn-shanghai.aliyuncs.com/terminal/3.6.0/en/File.png)\n\n![Editor](https://kkbapps.oss-cn-shanghai.aliyuncs.com/terminal/3.6.0/en/Editor.png)\n\n[**More Module Previews**](./doc/en_US/MODULE.md)\n\n### 💡 Function Description\n\n1. kkTerminal is a terminal for Web SSH connection. Click on the terminal icon in the upper-left corner and select the connection settings to establish an SSH connection\n\n2. Support the use of `iframe` tags in web pages for quick integration into third-party websites\n\n3. Support customizing terminal configuration through [URL Parameters](./doc/en_US/PARAMS.md)\n\n4. Support internationalization and language switching between Chinese and English\n\n5. Support local PC deployment, automatically opens browser window upon startup\n\n6. Support adaptive window size and Chinese input\n\n7. Support custom preference settings, allowing users to choose the background/foreground color, font size, cursor display style, enable TCode for the terminal, etc\n\n8. Support restart: It will automatically restart after modifying SSH connection settings or custom preference settings, or can be manually restarted after SSH connection is disconnected\n\n9. Support copy and paste:\n\n   - Copy: Same as `Git` terminal, selecting text will automatically copy it\n\n   - Paste: Same as `Cmd` terminal, right-click to paste (requires browser access permission)\n\n\n9. Support file management, open the File Management Module to view, decompress, upload and download files/folders\n\n10. Support shortcut key operations such as multiple/all file selection, copy and paste, cut, selection switch, open, etc\n\n11. Support file browsing and editing, modify the file and save it to a remote server using `ctrl+s`\n\n12. Support [TCode (Terminal Code)](./doc/en_US/TCODE.md)，which can achieve automated Workflow similar to Shell scripts through Customized TCode\n\n13. Support operation recording and cloud synchronization functions\n\n14. Support Cooperate, Monitor and Docker functions\n\n### 👨‍💻 Update Records\n\n##### zyyzyykk/kkterminal:3.6.0: latest\n\n- Add Advance Cooperate function\n- Add Advance Monitor function\n- Add Advance Docker function\n- Optimize packaging volume \u0026 webpage display\n\n##### zyyzyykk/kkterminal:3.5.6: \n\n- Support more URL parameters\n- Add editor text \u0026 image size percentage\n- Optimize webpage display\n\n##### zyyzyykk/kkterminal:3.5.3: \n\n- Add URL parameter to customize terminal configuration\n- Fix bug of multi window restart\n- Add operation recording and cloud synchronization functions\n- Refactoring some code logic\n\n[**History Update Records**](./doc/en_US/UPDATE.md)\n\n### 🧬 Architecture\n\n```markdown\n+---------+     http      +-------------+    ssh     +---------------+\n| browser | \u003c===========\u003e | kk Terminal | \u003c========\u003e | remote server |\n+---------+   websocket   +-------------+    sftp    +---------------+\nVue + Xterm              SpringBoot + SSHJ                Linux OS    \n```\n\n### 🏘️ About this project\n\nDear Users,\n\nI regret to announce that due to limited time and energy, I will not be able to maintenance on `kkTerminal` in the future.\n\nIf you are interested in `kkTerminal` or would like to continue maintaining, please feel free to contact me or raise an issue.\n\nIf you discover bugs or wish to develop new features, please also raise an issue.\n\nFinally, thank you for your support of `kkTerminal` and I sincerely hope that `kkTerminal` can really help you.\n\nBest Regards,\n\n[zyyzyykk](https://github.com/zyyzyykk/)\n\n2025.03.15\n\n### 🌟 Stars\n\n[![Stars](https://starchart.cc/zyyzyykk/kkTerminal.svg?variant=adaptive)](https://starchart.cc/zyyzyykk/kkTerminal)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzyyzyykk%2FkkTerminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzyyzyykk%2FkkTerminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzyyzyykk%2FkkTerminal/lists"}