https://github.com/amalshaji/portr

Open source ngrok alternative designed for teams. Tunnel http, tcp or websocket connections.
https://github.com/amalshaji/portr

cli developer-tools golang http ngrok-alternative ngrok-replacement open-source python reverse-tunnel self-hosted shadcn-svelte shadcn-ui ssh-tunnel svelte tcp tunneling

Last synced: about 8 hours ago
JSON representation

Open source ngrok alternative designed for teams. Tunnel http, tcp or websocket connections.

• Host: GitHub
• URL: https://github.com/amalshaji/portr
• Owner: amalshaji
• License: agpl-3.0
• Created: 2023-11-21T11:14:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-20T18:43:29.000Z (about 2 months ago)
• Last Synced: 2024-10-29T17:12:13.719Z (about 1 month ago)
• Topics: cli, developer-tools, golang, http, ngrok-alternative, ngrok-replacement, open-source, python, reverse-tunnel, self-hosted, shadcn-svelte, shadcn-ui, ssh-tunnel, svelte, tcp, tunneling
• Language: Python
• Homepage: https://portr.dev
• Size: 3.44 MB
• Stars: 2,300
• Watchers: 12
• Forks: 64
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - amalshaji/portr - Open source ngrok alternative designed for teams. Tunnel http, tcp or websocket connections. (Python)
• jimsghstars - amalshaji/portr - Open source ngrok alternative designed for teams. Tunnel http, tcp or websocket connections. (Python)

README

        



  








  

  

  






Portr is a tunnel solution that allows you to expose local http, tcp or websocket connections to the public internet. It utilizes SSH remote port forwarding under the hood to securely tunnel connections.

Portr is primarily designed for small teams looking to expose development servers on a public URL. It is not recommended for use alongside production servers.

> [!WARNING]

> Portr is currently in beta. Expect bugs and anticipate breaking changes.

## Features

- 🎉 Easily tunnel http, tcp or websocket connections.

- 👾 Admin dashboard for team/user management. [Watch video](https://www.youtube.com/watch?v=Wv5j3YQk3Ew).

- 🚨 Portr inspector for inspecting and replaying requests. [Watch video](https://www.youtube.com/watch?v=_4tipDzuoSs).

## Setup

- [Server setup guide](https://portr.dev/server/)

- [Client installation guide](https://portr.dev/client/installation/)

## Contributing

Please read through [our contributing guide](.github/contributing.md) and set up your [development environment](https://portr.dev/local-development/admin/).

## License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the  [LICENSE](/LICENSE) file for the full license text.