diff --git a/README.md b/README.md index 4b6d422..c7ca0d7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@
A simple Python-based application to manage SSH tunnels using PyQt5.
+Python tunneler. A simple Python-based application to manage existing SSH tunnels using PyQt5.
## 📝 Table of Contents @@ -23,7 +20,7 @@ - [Built Using](#built_using) - [Authors](#authors) -## 🧐 About +## 🚀 About Tunnel Manager is a Python application that provides a user interface fpr WIndows to manage SSH tunnels conveniently. It allows users to start, stop, and monitor SSH tunnels easily. @@ -31,7 +28,7 @@ Tunnel Manager is a Python application that provides a user interface fpr WIndow To get a copy of the project up and running on your local machine, follow these steps: -### Prerequisites +## Prerequisites ``` Windows 10+ (just tested it on 11 so far). @@ -40,7 +37,7 @@ Have the SSH connections already set up and configured. ``` -### 💻 Installation +## 💻 Installation Clone the repository: @@ -65,33 +62,43 @@ pip install -r requirements.txt ``` Define your connections in pytu.json +{ + "tunnels": [ { - "name": "Tunnel 1", + "name": "Tunnel to Ubuntu on Homeserver", "ssh": { - "port": 12345, + "port": 22, "options": ["-f", "-N"], "forwardings": [ { - "local_port": 8001, + "local_port": 81, "remote_host": "localhost", - "remote_port": 8000 + "remote_port": 80 }, { - "local_port": 3307, + "local_port": 8081, "remote_host": "localhost", - "remote_port": 3306 + "remote_port": 8080 + }, + { + "local_port": 8096, + "remote_host": "localhost", + "remote_port": 8096 } ], - "host": "192.168.1.100" + "user": "username", + "host": "192.168.0.1" } }, + […] + ``` ## 🎈 Usage To use the application, simply run the Python script `pytu.py`. This will launch the Tunnel Manager user interface, where you can start, stop, and monitor SSH tunnels. -## 🚀 Deployment +## 🏗️ Deployment For deploying this application on a live system, you can follow standard Python deployment procedures. @@ -102,7 +109,7 @@ For deploying this application on a live system, you can follow standard Python - [psutil](https://github.com/giampaolo/psutil) - Process Utilities - [subprocess](https://docs.python.org/3/library/subprocess.html) - Subprocess Management -## Screenshots 📸 +## 📸 Screenshots    @@ -110,9 +117,10 @@ For deploying this application on a live system, you can follow standard Python - [@tf4482](https://github.com/tf4482) - Developer -## License 📜 +## 📜 License Distributed under the MIT License. See LICENSE for more information. -**Project Link:** [https://github.com/tf482/improvo](https://github.com/tf482/improvo) +**Project Link:** [https://github.com/tf482/pytu](https://github.com/tf482/pytu) +**Project Link:** [https://github.com/tf482/pytu](https://github.com/tf482/pytu) diff --git a/pytu.pyw b/pytu.pyw index 87e0c54..3bbebc1 100644 --- a/pytu.pyw +++ b/pytu.pyw @@ -80,7 +80,7 @@ class TunnelManagerUI(QWidget): self.worker.update_signal.connect(self.update_status) self.worker.start() - self.setWindowTitle("Python Tunneler") + self.setWindowTitle("python tunneler") def create_ui(self): self.btn_start_all = QPushButton("Start All", self)