You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tailscale/cmd/tsconnect
Mihai Parparita 7741e9feb0 cmd/tsconnect: add progress and connection callbacks
Allows UI to display slightly more fine-grained progress when the SSH
connection is being established.

Updates tailscale/corp#7186

Signed-off-by: Mihai Parparita <mihai@tailscale.com>
2 years ago
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 2 years ago
src cmd/tsconnect: add progress and connection callbacks 2 years ago
wasm cmd/tsconnect: add progress and connection callbacks 2 years ago
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 2 years ago
README.md cmd/tsconnect: add dev-pkg command for two-sided development 2 years ago
build-pkg.go cmd/tsconnect: pre-compress main.wasm when building the NPM package 2 years ago
build.go all: fix spelling mistakes 2 years ago
common.go all: fix more resource leaks found by staticmajor 2 years ago
dev-pkg.go cmd/tsconnect: add dev-pkg command for two-sided development 2 years ago
dev.go cmd/tsconnect: add dev-pkg command for two-sided development 2 years ago
index.html cmd/tsconnect: switch UI to Preact 2 years ago
package.json cmd/tsconnect: switch to non-beta versions of xterm and related packages 2 years ago
package.json.tmpl cmd/tsconnect: move NPM package to being under the @tailscale org 2 years ago
serve.go refactor: move from io/ioutil to io and os packages 2 years ago
tailwind.config.js cmd/tsconnect: switch UI to Preact 2 years ago
tsconfig.json cmd/tsconnect: switch UI to Preact 2 years ago
tsconnect.go cmd/tsconnect: add dev-pkg command for two-sided development 2 years ago
yarn.lock cmd/tsconnect: switch to non-beta versions of xterm and related packages 2 years ago

README.md

tsconnect

The tsconnect command builds and serves the static site that is generated for the Tailscale Connect JS/WASM client.

Development

To start the development server:

./tool/go run ./cmd/tsconnect dev

The site is served at http://localhost:9090/. JavaScript and CSS changes can be picked up with a browser reload. Go changes (including to the wasm package) require the server to be stopped and restarted. In development mode the state the Tailscale client is stored in sessionStorage and will thus survive page reloads (but not the tab being closed).

Deployment

To build the static assets necessary for serving, run:

./tool/go run ./cmd/tsconnect build

To serve them, run:

./tool/go run ./cmd/tsconnect serve

By default the build output is placed in the dist/ directory and embedded in the binary, but this can be controlled by the -distdir flag. The -addr flag controls the interface and port that the serve listens on.

Library / NPM Package

The client is also available as an NPM package. To build it, run:

./tool/go run ./cmd/tsconnect build-pkg

That places the output in the pkg/ directory, which may then be uploaded to a package registry (or installed from the file path directly).

To do two-sided development (on both the NPM package and code that uses it), run:

./tool/go run ./cmd/tsconnect dev-pkg

This serves the module at http://localhost:9090/pkg/pkg.js and the generated wasm file at http://localhost:9090/pkg/main.wasm. The two files can be used as drop-in replacements for normal imports of the NPM module.