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
......@@ -20,7 +20,7 @@ wsssh is a swiss army's knife server assisted tunnelling system for the win init
### Key Components
#### Server Component
- **wssshd**: WebSocket SSH Daemon - Central server with web interface (Python)
- **wssshd**: WSSH Daemon - Central server with web interface (Python)
#### C Implementation (Primary)
- **wssshc**: Lightweight C client for registration (OpenSSL-based)
......@@ -261,7 +261,7 @@ Input: hostname (e.g., "myclient.example.com:9898")
## API Reference
### wssshd (WebSocket SSH Daemon)
### wssshd (WSSH Daemon)
#### Command Line Options
......@@ -311,7 +311,7 @@ web-https = false
- `ws://HOST:PORT/`: Main WebSocket endpoint for client connections
### wssshc (WebSocket SSH Client)
### wssshc (WSSH Client)
#### Command Line Options
......@@ -466,7 +466,7 @@ wsscp [SCP_OPTIONS...] SOURCE... DESTINATION
### 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
[default]
......@@ -521,7 +521,7 @@ The wssshd server requires:
### 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`
- Contains all daemon operations, client connections, tunnel requests
......@@ -1054,7 +1054,7 @@ python3 -m pytest tests/integration/
## 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
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
......@@ -37,8 +37,8 @@ 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:
### Server Component
1. **`wssshd`** - WebSocket SSH Daemon (server)
- Manages WebSocket connections with SSL/TLS encryption
1. **`wssshd`** - WSSH Daemon (server)
- Manages WebSocket connections with SSL/TLS encryption
- Handles client registrations with password authentication
- Routes tunnel requests to appropriate clients
- Professional web management interface with user administration
......@@ -48,8 +48,8 @@ The system consists of components implemented in C for optimal performance:
### wsssh tools (C Implementation)
Located in the `wssshtools/` directory:
1. **`wssshc`** - WebSocket SSH Client (registration)
- Registers client machines with the daemon
1. **`wssshc`** - WSSH Client (registration)
- Registers client machines with the daemon
- Maintains persistent WebSocket connection
- Automatic reconnection with configurable intervals
- Minimal dependencies (OpenSSL only)
......@@ -176,7 +176,7 @@ sudo make install
The C tools include comprehensive man pages:
```bash
man wssshc # WebSocket SSH client
man wssshc # WSSH client
man wsssh # SSH wrapper
man wsscp # SCP wrapper
```
......@@ -275,7 +275,7 @@ Port is specified using `-p` (SSH) or `-P` (SCP) options, or from config file.
## Detailed Usage
### wssshd (WebSocket SSH Daemon)
### wssshd (WSSH Daemon)
```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]
......@@ -314,7 +314,7 @@ When `--web-host` and `--web-port` are specified, a web management interface is
- User management (admin only)
- HTML5 terminal interface
### wssshc (WebSocket SSH Client)
### wssshc (WSSH Client)
```bash
./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
### 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
[default]
......@@ -467,7 +467,7 @@ The client will maintain a persistent WebSocket connection to the daemon.
## Logging and Monitoring
### 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
- **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.
## Donations
If you find WebSocket SSH useful, please consider supporting the project:
If you find WSSH useful, please consider supporting the project:
### PayPal
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
wssshc \- WebSocket SSH Client for registration
wssshc \- WSSH Client for registration
.SH SYNOPSIS
.B wssshc
[\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
wsssht \- WebSocket SSH Tunnel Setup Tool
wsssht \- WSSH Tunnel Setup Tool
.SH SYNOPSIS
.B wsssht
[\fB\-\-config\fR \fIFILE\fR]
......@@ -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)
.TP
.BR \-\-wssshd\-port " \fIPORT\fR"
WebSocket SSH daemon server port (default: 9898)
WSSH daemon server port (default: 9898)
.TP
.BR \-\-interval " \fISEC\fR"
Connection retry interval in seconds (default: 5)
......@@ -126,7 +126,7 @@ displays connection information:
.RS
.nf
========================================
WEBSSH TUNNEL READY
WSSH TUNNEL READY
========================================
Tunnel established successfully!
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