kkTerminal

A terminal for Web SSH connection

Author: zyyzyykk

Source Code: https://github.com/zyyzyykk/kkTerminal

Docker Hub: https://hub.docker.com/repository/docker/zyyzyykk/kkterminal/general

Preview: https://kkterminal.com

Update Time: 2026-10-11

English ｜ 简体中文

⚡ Quick Integration

<iframe src="https://kkterminal.com" height="600px" width="800px" ></iframe>

🐳 Deploy with Docker

1. Pull the latest image:

   docker pull zyyzyykk/kkterminal:latest
   

2. Create and run a container:

   docker run -d --name kkterminal \
   -p 3000:3000 \
   -e PASSWORD="" \
   -v /data/kkterminal:/data \
   zyyzyykk/kkterminal:latest
   

3. Configure the Nginx reverse proxy:

   # Deploy under the root path
   location ^~ / {
     proxy_pass http://127.0.0.1:3000;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header Host $http_host;
   
     proxy_http_version 1.1;
     proxy_set_header Upgrade $http_upgrade;
     proxy_set_header Connection "upgrade";
     proxy_read_timeout 36000s;
   }
   

   # Deploy under a subpath
   location ^~ /subpath/ {
     proxy_pass http://127.0.0.1:3000/;
     proxy_set_header X-Forwarded-Prefix /subpath;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header Host $http_host;
   
     proxy_http_version 1.1;
     proxy_set_header Upgrade $http_upgrade;
     proxy_set_header Connection "upgrade";
     proxy_read_timeout 36000s;
   }
   

4. Accessing in browser: http://<server ip>:3000/[subpath]

👀 Preview

Visit this website: https://kkterminal.com

More Modules Preview

💡 Function Description

1. Click the upper-left terminal icon and select Connect to establish an SSH connection
2. Use the <iframe> tag to quickly embed the terminal into third-party websites
3. Customize terminal settings via URL Parameters
4. Switch between Chinese and English for internationalization
5. Deploy on-premises on local PCs or remote servers
6. Adapt to window sizes and Chinese input
7. Configure preferences such as terminal background/foreground color, font size, cursor style, etc
8. Restart automatically or manually
9. Copy selected text automatically and paste with right-click
10. Manage files by opening the File module to browse, decompress, upload, and download files or folders
11. Perform file operations with shortcut keys, including multi-select, select all, copy, paste, cut, invert selection, open, delete, etc
12. Browse and edit files, then press Ctrl+S to save changes to the remote server
13. Execute customized workflows via Command Code
14. Record and replay terminal operations
15. Synchronize data between different devices
16. Provide advanced features: Cooperate, Monitor and Docker
17. Require password verification for access
18. Enable shell integration

👨‍💻 Update Records

zyyzyykk/kkterminal:3.8.8

• Add shell integration function
• Support subpath deployment
• File module adds follow terminal directory function
• Update some apps in docker appstore
• Add directory navigation dropdown in File module
• Refactoring cloud data storage path
• Optimize webpage display
• Enhance some functions

zyyzyykk/kkterminal:3.8.0

• Docker module adds container details display and app store updates
• Enhance compatibility of non-secure context and lower versions
• Upgrade project jdk and springboot version
• Refactoring some codes and optimizing UI display

zyyzyykk/kkterminal:3.7.6

• Support more URL parameters
• Optimize file transfer process
• Add access verify function
• User Command Code file module adds API
• Docker module adds viewing container details
• Fix bug of data request exception in Docker module
• Optimize webpage display
• Enhance some functions

History Update Records

🧬 Architecture

+---------+     http      +-------------+    ssh     +---------------+
| browser | <===========> | kk Terminal | <========> | remote server |
+---------+   websocket   +-------------+    sftp    +---------------+
Vue + Xterm              SpringBoot + SSHJ                Linux OS    

🛡️ Privacy and Security

[!Warning]

🔐 Zero-Knowledge Encryption

Cloud-synchronized data is protected with zero-knowledge encryption, so the service provider cannot access the original content.

⏱️ Temporary Storage

Files and private keys are stored only temporarily and are deleted after transfer or login is completed.

⚠️ Disclaimer

This project is provided on an "AS IS" basis for personal learning and research purposes only and any illegal use is prohibited.