jason/socktop-webterm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README and CARGO VERSION
Some checks failed
Build and Deploy to K3s / build-and-push (push) Successful in 4m22s
Details
Build and Deploy to K3s / deploy (push) Failing after 9s
Details

Browse Source
This commit is contained in:
jasonwitty 2025-11-28 14:45:14 -08:00
parent 12f2d6e6af
commit 29a97a43a9
3 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -2012,7 +2012,7 @@ dependencies = [
[[package]] [[package]]
name = "webterm" name = "webterm"
version = "0.2.2" version = "0.3.0"
dependencies = [ dependencies = [
"actix", "actix",
"actix-files", "actix-files",

2
Cargo.toml
View File

@ -6,7 +6,7 @@ documentation = "https://docs.rs/webterm"
readme = "README.md" readme = "README.md"
categories = ["web-programming", "web-programming::websocket", "web-programming::http-server", "command-line-utilities"] categories = ["web-programming", "web-programming::websocket", "web-programming::http-server", "command-line-utilities"]
keywords = ["terminal", "xterm", "websocket", "terminus", "console"] keywords = ["terminal", "xterm", "websocket", "terminus", "console"]
version = "0.2.2" version = "0.3.0"
authors = ["fabian.freyer@physik.tu-berlin.de","jasonpwitty+socktop@proton.me"] authors = ["fabian.freyer@physik.tu-berlin.de","jasonpwitty+socktop@proton.me"]
edition = "2021" edition = "2021"
license = "BSD-3-Clause" license = "BSD-3-Clause"

23
README.md
View File

@ -10,12 +10,12 @@ This is a modern web terminal server that provides browser-based terminal access
## Features ## Features
- 🖥️ Full-featured terminal emulation via xterm.js - Full-featured terminal emulation via xterm.js
- 🔌 WebSocket-based communication using the Terminado protocol - WebSocket-based communication using the Terminado protocol
- 🚀 High-performance Rust backend - High-performance Rust backend
- ⚡ Zero-downtime rolling deployments via CI/CD - Zero-downtime rolling deployments via CI/CD
- 🐳 Containerized deployment with Docker - Containerized deployment with Docker
- ☸️ Kubernetes/k3s ready with automated deployments - Kubernetes/k3s ready with automated deployments
## Architecture ## Architecture
@ -127,11 +127,6 @@ This project includes a complete CI/CD pipeline using Gitea Actions:
- **Automated k3s deployment** with rolling updates - **Automated k3s deployment** with rolling updates
- **Zero downtime** deployments - **Zero downtime** deployments
For setup instructions, see:
- [Getting Started Guide](GETTING-STARTED-CI-CD.md)
- [CI/CD Overview](CI-CD-OVERVIEW.md)
- [Quick Reference](.gitea/QUICKSTART.md)
## Technology Stack ## Technology Stack
- **Backend**: Rust 2021, Actix-Web 4.x, Actix 0.13, portable-pty - **Backend**: Rust 2021, Actix-Web 4.x, Actix 0.13, portable-pty
@ -142,12 +137,10 @@ For setup instructions, see:
- **Containerization**: Docker, Kubernetes/k3s - **Containerization**: Docker, Kubernetes/k3s
- **CI/CD**: Gitea Actions - **CI/CD**: Gitea Actions
## Security Considerations
⚠️ **Warning**: This application provides shell access to anyone who can access the web interface. It is intended for use in controlled environments only. Only run in Run in isolated containers/namespaces.
## Credits ## Credits
This project was originally forked from [webterm](https://github.com/fubarnetes/webterm) by Fabian Freyer. I chose this as a base because other projects were way too complex. His project was simple and easy to understand, but it was not well maintained. I have updated it to modern packages and heavily customized it to display a working demo for socktop.
### Original Author ### Original Author
This project is a fork of [webterm](https://github.com/fubarnetes/webterm) originally created by: This project is a fork of [webterm](https://github.com/fubarnetes/webterm) originally created by:
- **Fabian Freyer** (fabian.freyer@physik.tu-berlin.de) - **Fabian Freyer** (fabian.freyer@physik.tu-berlin.de)