Skip to content

Commit

Permalink
Merge branch 'release'
Browse files Browse the repository at this point in the history
  • Loading branch information
tf4482 committed Mar 30, 2024
2 parents 5b6ead5 + 53d63e1 commit bb79290
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 20 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
<h1 align="center">pytu</h1>
<h2 align="center">python tunneler</h1>

<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
![Status](https://img.shields.io/badge/status-active-success.svg)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

</div>

---

<p align="center"> A simple Python-based application to manage SSH tunnels using PyQt5. </p>
<p align="center">Python tunneler. A simple Python-based application to manage existing SSH tunnels using PyQt5.</p>

## 📝 Table of Contents

Expand All @@ -23,15 +20,15 @@
- [Built Using](#built_using)
- [Authors](#authors)

## 🧐 About <a name = "about"></a>
## 🚀 About <a name = "about"></a>

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.

## 🏁 Getting Started <a name = "getting_started"></a>

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).
Expand All @@ -40,7 +37,7 @@ Have the SSH connections already set up and configured.
```


### 💻 Installation
## 💻 Installation

Clone the repository:

Expand All @@ -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 <a name="usage"></a>

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 <a name = "deployment"></a>
## 🏗️ Deployment <a name = "deployment"></a>

For deploying this application on a live system, you can follow standard Python deployment procedures.

Expand All @@ -102,17 +109,18 @@ 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

![image](https://github.com/tf4482/pytu/assets/107394980/f3608356-9db6-4972-8fa2-b6b215f068db) ![image](https://github.com/tf4482/pytu/assets/107394980/f8b3e71e-66b2-4630-82ae-74e1e3ef4dac) ![image](https://github.com/tf4482/pytu/assets/107394980/937a0524-04b0-4537-95db-7e5d41a8e73d)

## ✍️ Authors <a name = "authors"></a>

- [@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)

2 changes: 1 addition & 1 deletion pytu.pyw
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit bb79290

Please sign in to comment.