The GUI
- Introduction
- Prerequisites
- Project-Structure
- Running-the-Application
- Troubleshooting
- Contributing
- License
NetWeaver - Multi-threaded TCP/Web/FTP Server (WARNING MAKE SURE TO RUN THE install_dependencies.py IN A VIRTUAL ENV)
A versatile, multi-threaded server application with a graphical user interface, supporting generic TCP, HTTP/HTTPS, and FTP protocols.
NetWeaver is a Python-based server application designed to provide flexible network services through a user-friendly graphical interface. It supports handling multiple client connections concurrently across different protocols, including a generic TCP server, a web server (HTTP and HTTPS), and an FTP server. The application aims to offer a simple yet powerful tool for testing network communications and serving files. Features
Multi-threaded Architecture: Handles multiple client connections simultaneously without blocking the main application thread.
Multiple Server Modes:
Generic TCP Server: For basic TCP communication and testing.
Web Server (HTTP): Serves static files from a specified root directory.
Web Server (HTTPS): Provides secure web serving using SSL/TLS with user-provided certificate and key files.
FTP Server: Supports basic FTP commands for file listing, retrieval, and storage, with user authentication.
Intuitive Graphical User Interface (GUI): Built with Tkinter, featuring a modern dark theme for easy configuration and real-time logging.
Real-time Logging: Displays server activity, client connections, requests, and errors directly within the GUI.
File System Security: Implements checks to prevent directory traversal attacks for both web and FTP serving.
Configurable Root Directories: Allows users to specify separate root directories for web and FTP content.
SSL/TLS Support: Enables secure communication for the HTTPS server mode.
Basic FTP Commands: Supports USER, PASS, PWD, CWD, LIST, RETR, STOR, PORT, and PASV commands.
To run NetWeaver, you need the following:
Python 3: The application is developed in Python 3.
run the install_depencies.py script
Clone the repository (or download the files):
git clone https://github.com/mrblue223/NetWeaver.git
cd Netweaver
Install dependencies:
python3 install_dependencies.py
Ensure the assets directory exists:
Make sure the assets/icons8-server-40.png file is present in the Netweaver/assets/ directory for the GUI icon to display correctly. If not, you can download it or provide your own icon.
To start the NetWeaver server GUI, navigate to the Netweaver directory and run the main.py script:
python main.py
Using the GUI
Once the GUI launches, you can configure and control the server using its intuitive interface. Server Controls
Start Server: Initiates the server on the specified port and mode.
Stop Server: Shuts down the running server.
Server Status: Displays the current status of the server (running/stopped), including its IP, port, mode, and configured root directories/SSL files.
You can select the desired server mode from the sidebar. The input fields in the main content area will dynamically adjust based on your selection. Generic TCP Server
Purpose: For basic TCP communication and testing.
Configuration: Only requires a Server Port.
Purpose: Serves static files over HTTP.
Configuration:
Server Port: The port for the HTTP server (e.g., 80, 8080).
Web Root Dir: Click "Browse..." to select the directory containing your web files (e.g., index.html, styles.css).
Purpose: Provides secure web serving using SSL/TLS.
Configuration:
Server Port: The port for the HTTPS server (e.g., 443, 8443).
Web Root Dir: Click "Browse..." to select the directory containing your web files.
SSL Cert File: Click "Browse..." to select your SSL certificate file (e.g., server.pem).
SSL Key File: Click "Browse..." to select your SSL private key file (e.g., key.pem).
Purpose: Allows clients to transfer files using the FTP protocol.
Configuration:
Server Port: The port for the FTP server (e.g., 21).
FTP Root Dir: Click "Browse..." to select the directory that will serve as the root for FTP operations.
FTP Server Credentials:
The FTP server currently uses hardcoded credentials for authentication:
Username: ftpuser
Password: ftppass
The large text area at the bottom of the main content frame displays real-time logs from the server. This includes:
Informational messages ([*], often in blue)
Success messages ([+], often in green)
Warning messages ([-], often in yellow)
Error messages ([-], often in red)
"Could not bind to port..." error: This usually means the port is already in use by another application, or you don't have the necessary permissions to use that port (e.g., ports below 1024 often require root/administrator privileges). Try a different port number (e.g., 9999).
"Web Root Directory is invalid or not set." / "FTP Root Directory is invalid or not set.": Ensure you have selected a valid, existing directory for the respective server mode before starting the server.
"SSL Certificate/Key file is invalid or not set.": Verify that your .pem certificate and key files exist and are correctly formatted.
Server not responding: Check the log area for any error messages. Ensure no firewall is blocking the chosen port.
GUI icon not showing: Make sure Pillow is installed and the assets/icons8-server-40.png file is in the correct location relative to main.py.
Contributions are welcome! If you find a bug, have a feature request, or want to contribute code, please follow these guidelines:
Report Bugs: Open an issue on the GitHub repository with a clear description of the bug, steps to reproduce it, and expected behavior.
Suggest Features: Open an issue to propose new features or enhancements.
Submit Pull Requests:
Fork the repository.
Create a new branch for your changes (git checkout -b feature/your-feature-name or bugfix/your-bug-name).
Make your changes and ensure the code adheres to existing style.
Write clear, concise commit messages.
Push your branch and open a pull request.
This project is licensed under The Unlicense - see the LICENSE file for details.