# porthole
`porthole` is a simple application to expose services running on your localhost
via some other host.

**NOTE**: Currently, only TCP-based services are supported.

## Quickstart
To use `porthole`, you need to have the server running on a host that is exposed
to the WWW.

### Server
To configure the server, run `porthole server configure`. This will prompt you
for the configuration values you need.

Once configured, you can run `porthole server start` to launch the server.

### Client
To configure the client, run `porthole client configure`. This will prompt you
for the configuration values you need.

Once configured, you can run `porthole client start <local_port> [remote_port]`.
If everything goes well, this will print a `<hostname>:<port>` that should be
publically accessible!

**NOTE**: `[remote_port]` above is optional. If omitted, a random port will be
assigned.