kkTerminal

# kkTerminal

> A terminal for Web SSH connection
>
> Author: [zyyzyykk](https://github.com/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
>

<p align="center"><a href="https://kkterminal.com" target="_blank" rel="noopener noreferrer"><img width="100" src="https://kkbapps.oss-cn-shanghai.aliyuncs.com/logo/terminal.svg" alt="kkTerminal"></a></p>

<p align="center">
  <a href="https://hub.docker.com/repository/docker/zyyzyykk/kkterminal/general"><img src="https://img.shields.io/docker/pulls/zyyzyykk/kkterminal?logo=docker" alt="Docker Image"></a>
  <a href="https://www.oracle.com/cn/java/technologies/downloads/#java8-windows"><img src="https://img.shields.io/badge/jdk-21-orange?logo=openjdk&logoColor=%23e3731c" alt="JDK Version"></a>
  <a href="https://spring.io/projects/spring-boot"><img src="https://img.shields.io/badge/springboot-3.5.10-green?color=6db33f&logo=springboot" alt="SpringBoot Version"></a>
  <a href="https://cn.vuejs.org/"><img src="https://img.shields.io/badge/vue-3.x-green?color=42b883&logo=vue.js" alt="Vue Version"></a>
  <a href="https://www.apache.org/licenses/"><img src="https://img.shields.io/badge/licence-Apache-red?logo=apache&logoColor=%23D22128" alt="Apache Licence"></a>
  <a href="https://github.com/zyyzyykk/kkTerminal"><img src="https://img.shields.io/github/stars/zyyzyykk/kkterminal" alt="GitHub"></a>
</p>
<p align="center">English ｜ <a href="./doc/zh_CN/README.md" >简体中文</a></p>

### ⚡ Quick Integration

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

### 🐳 Deploy with Docker

1. Pull the latest image:

   ```bash
   docker pull zyyzyykk/kkterminal:latest
   ```

2. Create and run a container:

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

3. Configure the Nginx reverse proxy:

   ```nginx
   # 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;
   }
   ```

   ```nginx
   # 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/