https://github.com/rajarakoto/ha-proxy
Streamlines the configuration and management of proxy tunnels, leveraging HA Tunnel Plus for services like HTTP, Git, VSCode and SSH. 🖧
https://github.com/rajarakoto/ha-proxy
cli hatunnel http network proxy ssh tunneling
Last synced: 3 months ago
JSON representation
Streamlines the configuration and management of proxy tunnels, leveraging HA Tunnel Plus for services like HTTP, Git, VSCode and SSH. 🖧
- Host: GitHub
- URL: https://github.com/rajarakoto/ha-proxy
- Owner: RajaRakoto
- License: mit
- Created: 2024-01-20T19:30:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-30T13:53:46.000Z (over 1 year ago)
- Last Synced: 2025-02-10T01:46:22.011Z (5 months ago)
- Topics: cli, hatunnel, http, network, proxy, ssh, tunneling
- Language: Shell
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ha-proxy 🖧
[](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com)
 
**Ha proxy** is a script designed to streamline the configuration and management of proxy tunnels, leveraging HA Tunnel Plus for services like HTTP, Git, VSCode, and SSH.
- Make sure to set the required environment variables in the `$HOME/.ha_env` file.
- Ensure that the necessary dependencies `akory`, `xxd`, `jq`, `git`, `xclip`, `corkscrew`, `gedit` and `bat` are installed.
> **Disclaimer:** This is provided for informational purposes only. Use this script responsibly and at your own risk. The author is not responsible for any misuse or damage caused.
---
### 📌 Usage
Run the following command to install ha-proxy (Linux only):
```bash
curl https://raw.githubusercontent.com/RajaRakoto/ha-proxy/master/setup > setup && chmod +x setup && ./setup
```
Uninstall ha-proxy (Linux only):
```bash
sudo rm -r "$HOME/.ha_env" /usr/local/bin/ha-proxy
```
---
### 📌 Features
**📜 Start proxy configuration**: Starts automatic proxy configuration for HTTP, Git, VSCode, and SSH.
```bash
ha-proxy --start
```
**📜 Stop proxy configuration**: Unsets all proxy configurations.
```bash
ha-proxy --stop
```
**📜 Check current proxy status**: Displays the current status of proxy configurations.
```bash
ha-proxy --status
```
**📜 Restart proxy configuration**: Restarts proxy configuration by stopping and then starting it.
```bash
ha-proxy --restart
```
**📜 Copy proxy information**: Copies proxy information to the clipboard.
```bash
ha-proxy --getProxy
```
**📜 Copy encoded proxy information**: Copies encoded proxy information to the clipboard.
```bash
ha-proxy --getProxyEncoded
```
**📜 Copy proxy server information**: Copies proxy server information to the clipboard.
```bash
ha-proxy --getProxyServer
```
**📜 Copy encoded proxy server information**: Copies encoded proxy server information to the clipboard.
```bash
ha-proxy --getProxyServerEncoded
```
**📜 Check script**: Checks for required variables and dependencies.
```bash
ha-proxy --check
```
**📜 Set env variables**: Sets environment variables using a text editor.
```bash
ha-proxy --env
```
**📜 Generate new SSH key**: Generates a new SSH (private|public) key.
```bash
ha-proxy --ssh
```
**📜 Fix env file**: Repair .ha_env file by regenerating it again in your home.
```bash
ha-proxy --fix
```
**📜 Display script version**: Display the current version of ha-proxy.
```bash
ha-proxy --version # or -v
```
**📜 Display help message**: Displays a help message with usage examples.
```bash
ha-proxy --help # or -h
```