soup/atelier
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

[porthole] Add README

Browse source
This commit is contained in:
soup 2025-04-12 00:27:47 -04:00
parent 748d65cbfe
commit 33841cb8ad
Signed by: soup
SSH key fingerprint: SHA256:GYxje8eQkJ6HZKzVWDdyOUF1TyDiprruGhE0Ym8qYDY
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
porthole/src/README.md Normal file
View file

@ -0,0 +1,24 @@
# porthole
`porthole` is a simple application to expose services running on your localhost
via some other host.
## 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.