Skip to content
/ Port Public

Persistent handling of port forwarding towards k8s with CLI and UI

License

Notifications You must be signed in to change notification settings

Fresa/Port

Repository files navigation

Port

Port is a Kubernetes port forward manager that keeps port forwarding connections persistent. It comes both with a CLI and a UI.

The application is still in early alpha and currently supports port forwarding and comes with a simple web UI.

Continuous Delivery

Installation

The web server is released as a self contained executable.

Have a look at the release section to find the latest release tag and replace <VERSION> with it below.

Windows

$VERSION="<VERSION>"
Invoke-WebRequest -Uri https://github.com/Fresa/Port/releases/download/$VERSION/port-$VERSION-win-x64.zip -O port.zip
Get-Item port.zip | Expand-Archive -DestinationPath "$env:LOCALAPPDATA\Port"
Remove-Item port.zip

Linux

version="<version>"
curl -fsSL -o install.sh https://raw.githubusercontent.com/Fresa/Port/$version/scripts/linux/install.sh
chmod 700 install.sh
./install.sh --version $version

TLS Certificate

By default Port listens on port 5001 over https. To configure a certificate edit the endpoint configuration in appsettings.Production.json found in the installation directory. Example:

"Kestrel": {
  "EndPoints": {
    "Https": {
      "Url": "https://localhost:5001",
      "Certificate": {
        "Path": "certificate.pfx",
        "Password": "<PASSWORD>",
        "AllowInvalid": "true"
      }
    }
  }
}

It's also possible to specify any configuration as arguments to port, for example the password. Example:

port --Kestrel:Endpoints:Https:Certificate:Password "<PASSWORD>"

This way you can source sensitive information from elsewhere.

Usage

The server is started by executing the executable.

Windows

.\Port.Server.exe

Linux

port

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

About

Persistent handling of port forwarding towards k8s with CLI and UI

Resources

License

Stars

Watchers

Forks

Packages

No packages published