fix: Replace 'WebSocket SSH' with 'WSSH' in documentation and man pages

- Update README.md to use 'WSSH' instead of 'WebSocket SSH' in various sections
- Update DOCUMENTATION.md to use 'WSSH' instead of 'WebSocket SSH'
- Update wssshtools/man/wssshc.1 to use 'WSSH Client' instead of 'WebSocket SSH Client'
- Update wssshtools/man/wsssht.1 to use 'WSSH' instead of 'WebSocket SSH' in descriptions
- Maintain consistency with the new project branding
parent 9e3c9377
# WSSSH:: Warp-Powered Stefy's Spatial Secure Hyperdrive Documentation # WSSSH: Warp-Powered Stefy's Spatial Secure Hyperdrive Documentation
## Table of Contents ## Table of Contents
...@@ -20,7 +20,7 @@ wsssh is a swiss army's knife server assisted tunnelling system for the win init ...@@ -20,7 +20,7 @@ wsssh is a swiss army's knife server assisted tunnelling system for the win init
### Key Components ### Key Components
#### Server Component #### Server Component
- **wssshd**: WebSocket SSH Daemon - Central server with web interface (Python) - **wssshd**: WSSH Daemon - Central server with web interface (Python)
#### C Implementation (Primary) #### C Implementation (Primary)
- **wssshc**: Lightweight C client for registration (OpenSSL-based) - **wssshc**: Lightweight C client for registration (OpenSSL-based)
...@@ -261,7 +261,7 @@ Input: hostname (e.g., "myclient.example.com:9898") ...@@ -261,7 +261,7 @@ Input: hostname (e.g., "myclient.example.com:9898")
## API Reference ## API Reference
### wssshd (WebSocket SSH Daemon) ### wssshd (WSSH Daemon)
#### Command Line Options #### Command Line Options
...@@ -311,7 +311,7 @@ web-https = false ...@@ -311,7 +311,7 @@ web-https = false
- `ws://HOST:PORT/`: Main WebSocket endpoint for client connections - `ws://HOST:PORT/`: Main WebSocket endpoint for client connections
### wssshc (WebSocket SSH Client) ### wssshc (WSSH Client)
#### Command Line Options #### Command Line Options
...@@ -466,7 +466,7 @@ wsscp [SCP_OPTIONS...] SOURCE... DESTINATION ...@@ -466,7 +466,7 @@ wsscp [SCP_OPTIONS...] SOURCE... DESTINATION
### Config File Configuration ### Config File Configuration
WebSocket SSH supports an optional INI-formatted configuration file at `~/.config/wsssh/wsssh.conf`: WSSH supports an optional INI-formatted configuration file at `~/.config/wsssh/wsssh.conf`:
```ini ```ini
[default] [default]
...@@ -521,7 +521,7 @@ The wssshd server requires: ...@@ -521,7 +521,7 @@ The wssshd server requires:
### Log Files and Locations ### Log Files and Locations
WebSocket SSH implements comprehensive logging with automatic rotation: WSSH implements comprehensive logging with automatic rotation:
- **wssshd Main Log**: `/var/log/wssshd/wssshd.log` - **wssshd Main Log**: `/var/log/wssshd/wssshd.log`
- Contains all daemon operations, client connections, tunnel requests - Contains all daemon operations, client connections, tunnel requests
...@@ -1054,7 +1054,7 @@ python3 -m pytest tests/integration/ ...@@ -1054,7 +1054,7 @@ python3 -m pytest tests/integration/
## Donations ## Donations
If you find WebSocket SSH useful, please consider supporting the project development: If you find WSSH useful, please consider supporting the project development:
### PayPal ### PayPal
Donate via PayPal to: **info@nexlab.net** Donate via PayPal to: **info@nexlab.net**
......
# WSSSH:: Warp-Powered Stefy's Spatial Secure Hyperdrive # WSSSH: Warp-Powered Stefy's Spatial Secure Hyperdrive
![WebSocket SSH Logo](logos/logo-256.png) ![WSSH Logo](logos/logo-256.png)
wsssh is a swiss army's knife server assisted tunnelling system for the win initially born as a websocket ssh tunnelling system and evolved to a universal tunnelling utility wsssh is a swiss army's knife server assisted tunnelling system for the win initially born as a websocket ssh tunnelling system and evolved to a universal tunnelling utility
...@@ -37,7 +37,7 @@ wsssh is a swiss army's knife server assisted tunnelling system for the win init ...@@ -37,7 +37,7 @@ wsssh is a swiss army's knife server assisted tunnelling system for the win init
The system consists of components implemented in C for optimal performance: The system consists of components implemented in C for optimal performance:
### Server Component ### Server Component
1. **`wssshd`** - WebSocket SSH Daemon (server) 1. **`wssshd`** - WSSH Daemon (server)
- Manages WebSocket connections with SSL/TLS encryption - Manages WebSocket connections with SSL/TLS encryption
- Handles client registrations with password authentication - Handles client registrations with password authentication
- Routes tunnel requests to appropriate clients - Routes tunnel requests to appropriate clients
...@@ -48,7 +48,7 @@ The system consists of components implemented in C for optimal performance: ...@@ -48,7 +48,7 @@ The system consists of components implemented in C for optimal performance:
### wsssh tools (C Implementation) ### wsssh tools (C Implementation)
Located in the `wssshtools/` directory: Located in the `wssshtools/` directory:
1. **`wssshc`** - WebSocket SSH Client (registration) 1. **`wssshc`** - WSSH Client (registration)
- Registers client machines with the daemon - Registers client machines with the daemon
- Maintains persistent WebSocket connection - Maintains persistent WebSocket connection
- Automatic reconnection with configurable intervals - Automatic reconnection with configurable intervals
...@@ -176,7 +176,7 @@ sudo make install ...@@ -176,7 +176,7 @@ sudo make install
The C tools include comprehensive man pages: The C tools include comprehensive man pages:
```bash ```bash
man wssshc # WebSocket SSH client man wssshc # WSSH client
man wsssh # SSH wrapper man wsssh # SSH wrapper
man wsscp # SCP wrapper man wsscp # SCP wrapper
``` ```
...@@ -275,7 +275,7 @@ Port is specified using `-p` (SSH) or `-P` (SCP) options, or from config file. ...@@ -275,7 +275,7 @@ Port is specified using `-p` (SSH) or `-P` (SCP) options, or from config file.
## Detailed Usage ## Detailed Usage
### wssshd (WebSocket SSH Daemon) ### wssshd (WSSH Daemon)
```bash ```bash
./wssshd --host 0.0.0.0 --port 9898 --domain example.com --password mysecret [--web-host 0.0.0.0 --web-port 8080] [--web-https] [--debug] ./wssshd --host 0.0.0.0 --port 9898 --domain example.com --password mysecret [--web-host 0.0.0.0 --web-port 8080] [--web-https] [--debug]
...@@ -314,7 +314,7 @@ When `--web-host` and `--web-port` are specified, a web management interface is ...@@ -314,7 +314,7 @@ When `--web-host` and `--web-port` are specified, a web management interface is
- User management (admin only) - User management (admin only)
- HTML5 terminal interface - HTML5 terminal interface
### wssshc (WebSocket SSH Client) ### wssshc (WSSH Client)
```bash ```bash
./wssshc --server-ip <ip> --port 9898 --id client1 --password mysecret [--tunnel websocket] [--tunnel-control websocket] [--interval 30] [--debug] ./wssshc --server-ip <ip> --port 9898 --id client1 --password mysecret [--tunnel websocket] [--tunnel-control websocket] [--interval 30] [--debug]
...@@ -408,7 +408,7 @@ Command line options override configuration file values. Required parameters are ...@@ -408,7 +408,7 @@ Command line options override configuration file values. Required parameters are
### Config File ### Config File
WebSocket SSH supports an optional INI-formatted configuration file at `~/.config/wsssh/wsssh.conf`: WSSH supports an optional INI-formatted configuration file at `~/.config/wsssh/wsssh.conf`:
```ini ```ini
[default] [default]
...@@ -467,7 +467,7 @@ The client will maintain a persistent WebSocket connection to the daemon. ...@@ -467,7 +467,7 @@ The client will maintain a persistent WebSocket connection to the daemon.
## Logging and Monitoring ## Logging and Monitoring
### Automatic Log Rotation ### Automatic Log Rotation
WebSocket SSH includes comprehensive logging with automatic log rotation managed by logrotate: WSSH includes comprehensive logging with automatic log rotation managed by logrotate:
- **wssshd logs**: `/var/log/wssshd/wssshd.log` - Main daemon logs with weekly rotation - **wssshd logs**: `/var/log/wssshd/wssshd.log` - Main daemon logs with weekly rotation
- **wssshc logs**: `/var/log/wssshc/wssshc.log` - Client daemon logs with weekly rotation - **wssshc logs**: `/var/log/wssshc/wssshc.log` - Client daemon logs with weekly rotation
...@@ -662,7 +662,7 @@ See [LICENSE.md](LICENSE.md) for the full license text. ...@@ -662,7 +662,7 @@ See [LICENSE.md](LICENSE.md) for the full license text.
## Donations ## Donations
If you find WebSocket SSH useful, please consider supporting the project: If you find WSSH useful, please consider supporting the project:
### PayPal ### PayPal
Donate via PayPal to: **info@nexlab.net** Donate via PayPal to: **info@nexlab.net**
......
.TH WSSHc 1 "September 2025" "wsssh-tools 1.4.0" "WSSSH:: Warp-Powered Stefy's Spatial Secure Hyperdrive" .TH WSSHc 1 "September 2025" "wsssh-tools 1.4.0" "WSSSH: Warp-Powered Stefy's Spatial Secure Hyperdrive"
.SH NAME .SH NAME
wssshc \- WebSocket SSH Client for registration wssshc \- WSSH Client for registration
.SH SYNOPSIS .SH SYNOPSIS
.B wssshc .B wssshc
[\fB\-\-server\-ip\fR \fIIP\fR] [\fB\-\-server\-ip\fR \fIIP\fR]
......
.TH WSSSHT 1 "September 2024" "WSSSH:: Warp-Powered Stefy's Spatial Secure Hyperdrive" "User Commands" .TH WSSSHT 1 "September 2024" "WSSSH: Warp-Powered Stefy's Spatial Secure Hyperdrive" "User Commands"
.SH NAME .SH NAME
wsssht \- WebSocket SSH Tunnel Setup Tool wsssht \- WSSH Tunnel Setup Tool
.SH SYNOPSIS .SH SYNOPSIS
.B wsssht .B wsssht
[\fB\-\-config\fR \fIFILE\fR] [\fB\-\-config\fR \fIFILE\fR]
...@@ -49,7 +49,7 @@ Specify the local IP address to bind the tunnel to (default: 127.0.0.1) ...@@ -49,7 +49,7 @@ Specify the local IP address to bind the tunnel to (default: 127.0.0.1)
Specify the wssshd server hostname (required if not in config) Specify the wssshd server hostname (required if not in config)
.TP .TP
.BR \-\-wssshd\-port " \fIPORT\fR" .BR \-\-wssshd\-port " \fIPORT\fR"
WebSocket SSH daemon server port (default: 9898) WSSH daemon server port (default: 9898)
.TP .TP
.BR \-\-interval " \fISEC\fR" .BR \-\-interval " \fISEC\fR"
Connection retry interval in seconds (default: 5) Connection retry interval in seconds (default: 5)
...@@ -126,7 +126,7 @@ displays connection information: ...@@ -126,7 +126,7 @@ displays connection information:
.RS .RS
.nf .nf
======================================== ========================================
WEBSSH TUNNEL READY WSSH TUNNEL READY
======================================== ========================================
Tunnel established successfully! Tunnel established successfully!
Local port: 49234 Local port: 49234
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment