Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdenio committed Jan 15, 2022
1 parent e8e1d95 commit 8963bfe
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Underpass

Self-hosted [ngrok](https://ngrok.com) alternative.

## Installation (CLI)

```bash
brew install cjdenio/tap/underpass
```

Or, download a release from the [releases page](https://github.com/cjdenio/underpass/releases/latest).

## Usage with hosted server

There's a hosted instance running at https://underpass.clb.li.

```bash
underpass -p <port> -s <optional subdomain>
```

## Self-hosting

(more docs coming soon, possibly)

```bash
go run ./cmd/server --host <host here>
```

```bash
underpass -p <port> --host <host here> -s <optional subdomain>
```

## Known caveats

- No WebSocket support

0 comments on commit 8963bfe

Please sign in to comment.