diff --git a/README.md b/README.md index 0634035..bf68ecf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,25 @@ # tty-proxy -## Building the gobindata.go file +[![Build Status](https://travis-ci.com/elisescu/tty-proxy.svg?token=N6UZN7xxNqNmweAn6y5D&branch=master)](https://travis-ci.com/elisescu/tty-proxy) -All files under ~assets/*~ are packed to the gobindata.go file which will be statically compiled +This is the public facing service that allows `tty-share` command to create public sessions, in +addition to local ones. + +`tty-proxy` will listen to the address passed by the `--back-address` flag, and any connections to +this address from `tty-share` will create a new session (`` that will be used to proxy +any requests from any url path of the form `/s//` back over the corresponding +`tty-share` connection. See more documentation on the +[tty-share](https://github.com/elisescu/tty-share) project. + +**Note** `tty-proxy` replaces a part of the old `tty-server` which has moved inside the actual +`tty-share` command itself. Read more +[here](https://github.com/elisescu/tty-share/wiki/tty-share-V2) + +## Building + +### Build the gobindata.go file + +All files under `assets/*` are packed to the `gobindata.go` file which will be statically compiled within the final binary. ```bash @@ -10,6 +27,12 @@ within the final binary. go-bindata --prefix static -o gobindata.go static/* ``` +### Build the final `tty-proxy` binary + +```bash +go build +``` + ## Docker The `tty-proxy` can be built into a docker image as follows: