https://github.com/igrmk/procto

Reverse proxy exposing your localhost to the internet
https://github.com/igrmk/procto

localhost proxy reverse-proxy tunnel

Last synced: 23 days ago
JSON representation

Reverse proxy exposing your localhost to the internet

• Host: GitHub
• URL: https://github.com/igrmk/procto
• Owner: igrmk
• License: unlicense
• Created: 2022-10-17T21:51:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-12T12:57:00.000Z (7 months ago)
• Last Synced: 2024-06-12T16:58:11.478Z (7 months ago)
• Topics: localhost, proxy, reverse-proxy, tunnel
• Language: Shell
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Procto

======

A script to set up a reverse proxy exposing your localhost to the internet.

It provisions a virtual machine with:

- A Let's Encrypt certificate

- Nginx to proxy from remote HTTPS to remote HTTP

- SSH to proxy from remote HTTP to local HTTP

Essentially, it's a poor man's alternative to ngrok.

```mermaid

graph TB

Client(Client on the Internet)

Nginx(NGINX)

SshServer(SSH server)

SshClient(SSH client)

Server(Your local server)

Client -- HTTPS --> Nginx

subgraph Your proxy server

    Nginx --HTTP --> SshServer

end

SshServer -- HTTP over SSH --> SshClient

subgraph Your localhost

    SshClient -- HTTP --> Server

end

```

Usage

-----

  * Get a Debian-based cloud virtual machine

  * Get a domain and point it to your virtual machine

  * Clone this project to your local machine

  * Add the project directory to your PATH

  * Copy `example.conf` to `~/.procto/.conf` and fill it

  * Use `procto-provision ` command to provision your remote VM

  * Use `procto-connect ` command to proxy remote HTTPS to local HTTP

  * Use `procto-disconnect ` command to stop the proxy

If you need to set up additional ssh parameters, you can add them to your `~/.ssh/config`.