Commit 4e680dc1 authored by nextime's avatar nextime

Update documentation for wsssh-server Debian package v1.4.0

- Updated README.md with wsssh-server package installation instructions
- Updated DOCUMENTATION.md with wsssh-server package details and build instructions
- Added comprehensive wsssh-server package features and usage examples
- Updated project structure to include wsssh-server package directory
- Enhanced build instructions with --server-only option details
- Added wsssh-server package benefits and enterprise features
- Updated changelog section to reflect version 1.4.0 features
- Improved documentation consistency across all files
parent ff20df1c
...@@ -37,6 +37,9 @@ WebSocket SSH (wsssh) is a tunneling system that enables secure SSH/SCP access t ...@@ -37,6 +37,9 @@ WebSocket SSH (wsssh) is a tunneling system that enables secure SSH/SCP access t
- **Simplified CLI**: No need to specify "ssh" or "scp" commands explicitly - **Simplified CLI**: No need to specify "ssh" or "scp" commands explicitly
- **Drop-in Replacement**: Compatible with existing SSH/SCP workflows - **Drop-in Replacement**: Compatible with existing SSH/SCP workflows
- **Debian Packaging**: Professional system integration with dependencies - **Debian Packaging**: Professional system integration with dependencies
- **wsssh-server Package**: Standalone Debian package for wssshd daemon
- **PyInstaller Binary**: Standalone wssshd binary with no Python dependencies
- **Professional Service Management**: Complete init scripts and service integration
- **Cross-platform**: Works on Linux, macOS, and Windows - **Cross-platform**: Works on Linux, macOS, and Windows
- **Donation Support**: Community funding through PayPal and cryptocurrency - **Donation Support**: Community funding through PayPal and cryptocurrency
...@@ -592,7 +595,7 @@ wsssh/ ...@@ -592,7 +595,7 @@ wsssh/
├── wssshc.py # WebSocket SSH Client (Python) ├── wssshc.py # WebSocket SSH Client (Python)
├── wsssh.py # SSH wrapper (Python) ├── wsssh.py # SSH wrapper (Python)
├── wsscp.py # SCP wrapper (Python) ├── wsscp.py # SCP wrapper (Python)
├── build.sh # Build script (supports --debian) ├── build.sh # Build script (supports --debian, --server-only)
├── clean.sh # Clean script ├── clean.sh # Clean script
├── requirements.txt # Python dependencies ├── requirements.txt # Python dependencies
├── cert.pem # SSL certificate (auto-generated) ├── cert.pem # SSL certificate (auto-generated)
...@@ -605,12 +608,24 @@ wsssh/ ...@@ -605,12 +608,24 @@ wsssh/
│ ├── wsscp.c # C SCP wrapper (418 lines) │ ├── wsscp.c # C SCP wrapper (418 lines)
│ ├── configure.sh # Build configuration │ ├── configure.sh # Build configuration
│ ├── Makefile # GNU Make build system │ ├── Makefile # GNU Make build system
│ └── debian/ # Debian packaging │ └── debian/ # Debian packaging for wsssh-tools
│ ├── control # Package metadata │ ├── control # Package metadata
│ ├── rules # Build rules │ ├── rules # Build rules
│ ├── changelog # Package changelog │ ├── changelog # Package changelog
│ ├── copyright # Copyright info │ ├── copyright # Copyright info
│ └── compat # Debhelper compatibility │ └── compat # Debhelper compatibility
├── wsssh-server/ # wsssh-server Debian package (v1.4.0)
│ ├── debian/ # Debian packaging for wssshd daemon
│ │ ├── control # Package metadata
│ │ ├── rules # Build rules with PyInstaller
│ │ ├── changelog # Package changelog
│ │ ├── copyright # Copyright info
│ │ ├── compat # Debhelper compatibility
│ │ ├── wssshd.1 # Man page for wssshd
│ │ ├── postinst # Post-installation script
│ │ ├── postrm # Post-removal script
│ │ └── wssshd.default # Service defaults
│ └── PyInstaller/ # PyInstaller spec files
├── .gitignore # Git ignore rules ├── .gitignore # Git ignore rules
├── LICENSE.md # GPLv3 license ├── LICENSE.md # GPLv3 license
├── README.md # Main documentation ├── README.md # Main documentation
...@@ -683,6 +698,39 @@ sudo make install ...@@ -683,6 +698,39 @@ sudo make install
sudo dpkg -i dist/wsssh-tools*.deb sudo dpkg -i dist/wsssh-tools*.deb
``` ```
#### wsssh-server Debian Package (v1.4.0)
```bash
# Build wsssh-server package only
./build.sh --server-only
# Install wsssh-server package
sudo dpkg -i dist/wsssh-server*.deb
# Configure the service
sudo cp /usr/share/wsssh/wssshd.conf.example /etc/wssshd.conf
sudo editor /etc/wssshd.conf
# Enable and start the service
sudo echo "START=yes" > /etc/default/wssshd
sudo /etc/init.d/wssshd start
# Check service status
sudo /etc/init.d/wssshd status
# View the man page
man wssshd
```
**wsssh-server Package Features:**
- Standalone PyInstaller binary with no Python dependencies
- Professional init script with wssshd user/group support
- Automatic user/group creation during installation
- Complete service management (start/stop/restart/status/reload)
- Integration with Debian init system and rc2.d
- /etc/default/wssshd service control configuration
- Comprehensive wssshd man page documentation
- Secure daemon operation with minimal privileges
#### Clean Build Artifacts #### Clean Build Artifacts
```bash ```bash
# Clean all build artifacts # Clean all build artifacts
......
...@@ -18,6 +18,9 @@ A modern SSH tunneling system that uses WebSocket connections to securely route ...@@ -18,6 +18,9 @@ A modern SSH tunneling system that uses WebSocket connections to securely route
- **Multi-client Support**: Route connections to different registered clients - **Multi-client Support**: Route connections to different registered clients
- **Cross-platform**: Works on Linux, macOS, and Windows - **Cross-platform**: Works on Linux, macOS, and Windows
- **Debian Packaging**: Easy installation with proper system integration - **Debian Packaging**: Easy installation with proper system integration
- **wsssh-server Package**: Standalone Debian package for wssshd daemon
- **PyInstaller Binary**: Standalone wssshd binary with no Python dependencies
- **Professional Service Management**: Complete init scripts and service integration
- **Donation Support**: Community funding through PayPal and cryptocurrency - **Donation Support**: Community funding through PayPal and cryptocurrency
## Architecture ## Architecture
...@@ -89,13 +92,37 @@ Download the latest release binaries for your platform from the releases page. ...@@ -89,13 +92,37 @@ Download the latest release binaries for your platform from the releases page.
### Debian Package Installation ### Debian Package Installation
For Debian/Ubuntu systems, you can install the C implementation via Debian package: For Debian/Ubuntu systems, you can install both the server and client components via Debian packages:
#### wsssh-server Package (Daemon)
```bash ```bash
# Build the Debian package # Build the wsssh-server package
./build.sh --debian ./build.sh --server-only
# Install the server package
sudo dpkg -i dist/wsssh-server*.deb
# Configure the service
sudo cp /usr/share/wsssh/wssshd.conf.example /etc/wssshd.conf
sudo editor /etc/wssshd.conf
# Enable and start the service
sudo echo "START=yes" > /etc/default/wssshd
sudo /etc/init.d/wssshd start
# Check service status
sudo /etc/init.d/wssshd status
# View the man page
man wssshd
```
# Install the package #### wsssh-tools Package (C Implementation)
```bash
# Build the wsssh-tools package
./build.sh --wssshtools-only
# Install the client package
sudo dpkg -i dist/wsssh-tools*.deb sudo dpkg -i dist/wsssh-tools*.deb
# The C tools will be available system-wide # The C tools will be available system-wide
...@@ -104,6 +131,15 @@ wsssh --help ...@@ -104,6 +131,15 @@ wsssh --help
wsscp --help wsscp --help
``` ```
#### Build Both Packages
```bash
# Build both packages
./build.sh --debian
# Install both packages
sudo dpkg -i dist/wsssh-server*.deb dist/wsssh-tools*.deb
```
### C Implementation Build ### C Implementation Build
To build the C tools from source: To build the C tools from source:
...@@ -511,7 +547,19 @@ Your support helps us continue developing and maintaining this open-source proje ...@@ -511,7 +547,19 @@ Your support helps us continue developing and maintaining this open-source proje
## Changelog ## Changelog
### Version 1.3.4 (Latest) ### Version 1.4.0 (Latest)
- **wsssh-server Debian Package**: Complete standalone Debian package for wssshd daemon
- **PyInstaller Binary Packaging**: wssshd packaged as standalone executable with no Python dependencies
- **Professional Service Management**: Complete init scripts with wssshd user/group support and rc2.d integration
- **Comprehensive wssshd Man Page**: Full documentation for wssshd daemon with usage examples and configuration
- **Enhanced Build System**: Updated build.sh with --server-only option for selective package building
- **Multi-Package Architecture**: Separate wsssh-server (daemon) and wsssh-tools (clients) packages
- **Security Hardening**: Dedicated wssshd user/group with minimal privileges and proper file ownership
- **System Integration**: Complete Debian packaging with postinst/postrm scripts and service management
- **Configuration Management**: /etc/default/wssshd service control and /etc/wssshd.conf configuration
- **Enterprise Ready**: Production-grade deployment with professional standards compliance
### Version 1.3.4
- **Enhanced WebSocket Connection Management**: Robust ping/pong frame handling and automatic reconnection for wsssh.c and wsscp.c - **Enhanced WebSocket Connection Management**: Robust ping/pong frame handling and automatic reconnection for wsssh.c and wsscp.c
- **Fixed Ping Frame Parsing**: Corrected WebSocket ping frame processing in C implementations with proper pong responses - **Fixed Ping Frame Parsing**: Corrected WebSocket ping frame processing in C implementations with proper pong responses
- **Automatic Reconnection Logic**: Added smart reconnection with 1-second intervals for WebSocket recovery and configurable --interval for initial setup - **Automatic Reconnection Logic**: Added smart reconnection with 1-second intervals for WebSocket recovery and configurable --interval for initial setup
...@@ -523,4 +571,4 @@ Your support helps us continue developing and maintaining this open-source proje ...@@ -523,4 +571,4 @@ Your support helps us continue developing and maintaining this open-source proje
- Improved C implementation files for better performance and reliability - Improved C implementation files for better performance and reliability
- Added dedicated clean script for easier project maintenance - Added dedicated clean script for easier project maintenance
See [CHANGELOG.md](CHANGELOG.md) for version history and changes. See [CHANGELOG.md](CHANGELOG.md) for complete version history and changes.
\ No newline at end of file \ No newline at end of file
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