From 2b5a5acff986d743a5f83d6558df596cc73eff02 Mon Sep 17 00:00:00 2001 From: Ryan Malloy Date: Mon, 10 Feb 2025 07:56:30 +0000 Subject: [PATCH] Updated --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41e339f..d65c7f9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ # Caddy Module: Websocket/Telnet Proxy +TelnetProxy is a [Caddy](https://caddyserver.com) module that proxies WebSocket connections to Telnet servers. This module allows clients to securely connect via WebSockets and interact with Telnet servers, making it easier to expose legacy Telnet services over modern web protocols. + +## Features + +- **WebSocket to Telnet Proxy:** Forwards WebSocket connections to Telnet servers. +- **Authentication:** Uses a shared secret to authenticate incoming WebSocket connections. +- **Caddy Integration:** Easily integrated with Caddy via the Caddyfile. +- **Timeout Handling:** Includes dial and inactivity timeouts for more robust connections. +- **Modular & Extendable:** Built as a Caddy module for easy inclusion in custom Caddy builds. + +## Requirements + +- [Caddy v2](https://caddyserver.com/docs/v2) +- [Go](https://golang.org/) (version 1.16 or later is recommended) +- [Gorilla WebSocket](https://github.com/gorilla/websocket) + +## Installation + +There are two primary ways to use TelnetProxy with Caddy: + +### 1. Build as a Plugin for Caddy + +Clone this repository and follow [Caddy's custom build instructions](https://caddyserver.com/docs/extending-caddy) to include the module in your Caddy binary. + +```bash +git clone https://github.com/yourusername/telnetproxy.git +cd telnetproxy +go build ./... + + + [GAIA](https://aistudio.google.com/app/prompts?state=%7B%22ids%22:%5B%221TZojNHHHimN35L0xxFXjHtuUVjufmy8q%22%5D,%22action%22:%22open%22,%22userId%22:%22100999063508256084521%22,%22resourceKeys%22:%7B%7D%7D&usp=sharing) ## Client @@ -15,5 +46,3 @@ ## Commercial Products - https://www.ftelnet.ca/download/ -## -