Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zyyzyykk/kkTerminal
A terminal for Web SSH connection
https://github.com/zyyzyykk/kkTerminal
docker sftp shell ssh ssh-client ssh-server terminal web xterm xterm-js
Last synced: 2 months ago
JSON representation
A terminal for Web SSH connection
- Host: GitHub
- URL: https://github.com/zyyzyykk/kkTerminal
- Owner: zyyzyykk
- License: apache-2.0
- Created: 2023-10-14T08:05:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-16T06:16:33.000Z (2 months ago)
- Last Synced: 2024-12-16T07:25:16.591Z (2 months ago)
- Topics: docker, sftp, shell, ssh, ssh-client, ssh-server, terminal, web, xterm, xterm-js
- Language: Vue
- Homepage: https://ssh.kkbpro.com/
- Size: 48.8 MB
- Stars: 318
- Watchers: 4
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kkTerminal
> kkTerminal, a terminal for Web SSH connection
>
> Author: [zyyzyykk](https://github.com/zyyzyykk/)
>
> Source Code: https://github.com/zyyzyykk/kkTerminal
>
> Docker Hub Address: https://hub.docker.com/repository/docker/zyyzyykk/kkterminal/general
>
> Preview: https://ssh.kkbpro.com/ (For domestic servers) or https://ssh.kkbapps.com/ (For foreign servers)
>
> Update Time: 2024-12-07
>
English ｜ 简体中文
### ⚡ Quick integration
Using the `iframe` tag in HTML web pages to quick integration:
```html
```
### 🐳 Deploy with Docker
1.Pull image:
```bash
docker pull zyyzyykk/kkterminal
```
2.Create and run a container for port mapping: `-p port:3000`
```bash
docker run -d --name kkterminal -p 3000:3000 zyyzyykk/kkterminal
```
3.Mount data volume: `-v path:/data`
```bash
docker run -d --name kkterminal -p 3000:3000 -v /data:/data zyyzyykk/kkterminal
```
4.Custom art word: `-e TITLE="ArtWord"`
```bash
docker run -d --name kkterminal -p 3000:3000 -e TITLE="kkbpro" zyyzyykk/kkterminal
```
5.Accessing in browser: `http://server-ip:3000/`
### 🛸 Preview
Visit the following website:
- 🌐 For domestic servers: https://ssh.kkbpro.com/
- 🌍 For foreign servers: https://ssh.kkbapps.com/
[**More Module Previews**](./doc/en_US/MODULE.md)
### 💡 Function Description
1.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
2.Support the use of `iframe` tags in web pages for quick integration into third-party websites
3.Supports internationalization and language switching between Chinese and English
4.Supports local PC deployment, automatically opens browser window upon startup
5.Support adaptive window size and Chinese input
6.Support custom preference settings, allowing users to choose the background/foreground color, font size, cursor display style and enable TCode for the terminal
7.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
8.Support copy and paste:
- Copy: Same as `Git` terminal, selecting text will automatically copy it
- Paste: Same as `Cmd` terminal, right-click to paste (requires browser access permission)
9.Support file management, open the File Management Module to view, decompress, upload and download files/folders
10.Support shortcut key operations such as multiple/all file selection, copy and paste, cut, selection switch, open
11.Support file browsing and editing, modify the file and save it to a remote server using `ctrl+s`
12.Support [TCode (Terminal Code)](./doc/en_US/TCODE.md)，which can achieve automated Workflow similar to Shell scripts through Customized TCode
### 👨💻 Update Records
##### zyyzyykk/kkterminal:3.4.2: latest
- Implement internationalization and support language switching between Chinese and English
- Refactored some logic of code
##### zyyzyykk/kkterminal:3.4.0:
- Add SSH Option and custom TCode deletion function
- Fixed folder pasting failure bug in File Module
- Optimized network resources and page display
##### zyyzyykk/kkterminal:3.3.7:
- Adaptive remote server encoding format
- Expand highlighting file types
- Add file item keyboard selection switch and open
- Optimization of hidden file icon style
[**History Update Records**](./doc/en_US/UPDATE.md)
### 🧬 Architecture
```markdown
+---------+ http +-------------+ ssh +---------------+
| browser | <===========> | kk Terminal | <========> | remote server |
+---------+ websocket +-------------+ sftp +---------------+
Vue + Xterm SpringBoot + SSHJ Linux OS
```
### 🏘️ About this project
Author: [zyyzyykk](https://github.com/zyyzyykk/)
Welcome to provide valuable opinions or suggestions on this project, and you can also join us in maintaining and developing this project together
### 🌟 Stars
[](https://starchart.cc/zyyzyykk/kkTerminal)