From 29a97a43a9b8189823fe08a97ff09d4f7f3165bb Mon Sep 17 00:00:00 2001 From: jasonwitty Date: Fri, 28 Nov 2025 14:45:14 -0800 Subject: [PATCH] update README and CARGO VERSION --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 23 ++++++++--------------- 3 files changed, 10 insertions(+), 17 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 9c3da68..cb6cbca 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2012,7 +2012,7 @@ dependencies = [ [[package]] name = "webterm" -version = "0.2.2" +version = "0.3.0" dependencies = [ "actix", "actix-files", diff --git a/Cargo.toml b/Cargo.toml index 35d017e..f18d426 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ documentation = "https://docs.rs/webterm" readme = "README.md" categories = ["web-programming", "web-programming::websocket", "web-programming::http-server", "command-line-utilities"] 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"] edition = "2021" license = "BSD-3-Clause" diff --git a/README.md b/README.md index de23050..c932bb7 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,12 @@ This is a modern web terminal server that provides browser-based terminal access ## Features -- πŸ–₯️ Full-featured terminal emulation via xterm.js -- πŸ”Œ WebSocket-based communication using the Terminado protocol -- πŸš€ High-performance Rust backend -- ⚑ Zero-downtime rolling deployments via CI/CD -- 🐳 Containerized deployment with Docker -- ☸️ Kubernetes/k3s ready with automated deployments +- Full-featured terminal emulation via xterm.js +- WebSocket-based communication using the Terminado protocol +- High-performance Rust backend +- Zero-downtime rolling deployments via CI/CD +- Containerized deployment with Docker +- Kubernetes/k3s ready with automated deployments ## Architecture @@ -127,11 +127,6 @@ This project includes a complete CI/CD pipeline using Gitea Actions: - **Automated k3s deployment** with rolling updates - **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 - **Backend**: Rust 2021, Actix-Web 4.x, Actix 0.13, portable-pty @@ -142,12 +137,10 @@ For setup instructions, see: - **Containerization**: Docker, Kubernetes/k3s - **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 +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 This project is a fork of [webterm](https://github.com/fubarnetes/webterm) originally created by: - **Fabian Freyer** (fabian.freyer@physik.tu-berlin.de)