Skip to content

Commit

Permalink
Rename to bin/heroku-install
Browse files Browse the repository at this point in the history
  • Loading branch information
owenthereal committed Jul 11, 2020
1 parent 777b4f0 commit 1bc7d6f
Showing 2 changed files with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -145,9 +145,22 @@ A community Upterm server is running at `uptermd.upterm.dev` and `upterm` points

## Deploy Uptermd

### Kubernetes

You can deploy uptermd to a Kubernetes cluster. Install it with [helm](https://helm.sh):

```
$ helm repo add upterm https://upterm.dev
$ helm repo update
$ helm search repo upterm
NAME CHART VERSION APP VERSION DESCRIPTION
upterm/uptermd 0.1.0 0.4.1 Secure Terminal Sharing
$ helm install uptermd upterm/uptermd
```

### Heroku

The easiest and the cheapest way to deploy a [Upterm server](https://github.com/jingweno/upterm/tree/master/cmd/uptermd) (a.k.a. `uptermd`) is to use [Heroku](https://heroku.com).
The cheapest way to deploy a worry-free [Upterm server](https://github.com/jingweno/upterm/tree/master/cmd/uptermd) (a.k.a. `uptermd`) is to use [Heroku](https://heroku.com).
Heroku offers [free Dyno hours](https://www.heroku.com/pricing) which should be sufficient for most casual uses.

You can deploy with one click of the following button:
@@ -156,19 +169,19 @@ You can deploy with one click of the following button:

You can also automate the deployment with [Heroku Terraform](https://devcenter.heroku.com/articles/using-terraform-with-heroku).
The Heroku Terraform scripts are in the [terraform/heroku folder](./terraform/heroku).
A [util script](./bin/uptermd-install) is provided for your convenience to automate everything:
A [util script](./bin/heroku-install) is provided for your convenience to automate everything:

```
$ git clone https://github.com/jingweno/upterm
$ cd upterm
# Provinsion uptermd in Heroku Common Runtime.
# Follow instructions
$ bin/uptermd-install
$ bin/heroku-install
# Provinsion uptermd in Heroku Private Spaces.
# Follow instructions
$ TF_VAR_heroku_region=REGION TF_VAR_heroku_space=SPACE_NAME TF_VAR_heroku_team=TEAM_NAME bin/uptermd-install
$ TF_VAR_heroku_region=REGION TF_VAR_heroku_space=SPACE_NAME TF_VAR_heroku_team=TEAM_NAME bin/heroku-install
```

You **must** use WebScoket as the protocol for a Heroku-deployed Uptermd server because the platform only support HTTP/HTTPS routing.
@@ -182,19 +195,6 @@ $ upterm host --server wss://YOUR_HEROKU_APP_URL -- YOUR_COMMAND
$ ssh -o ProxyCommand='upterm proxy wss://TOKEN@YOUR_HEROKU_APP_URL' TOKEN@YOUR_HEROKU_APP_URL:443
```

### Kubernetes

You can deploy uptermd to a Kubernetes cluster. Install it with [helm](https://helm.sh):

```
$ helm repo add upterm https://upterm.dev
$ helm repo update
$ helm search repo upterm
NAME CHART VERSION APP VERSION DESCRIPTION
upterm/uptermd 0.1.0 0.4.1 Secure Terminal Sharing
$ helm install uptermd upterm/uptermd
```

## License

[Apache 2.0](https://github.com/jingweno/upterm/blob/master/LICENSE)
File renamed without changes.

0 comments on commit 1bc7d6f

Please sign in to comment.