tailscale/cmd/tsconnect
Mihai Parparita 63ad49890f cmd/tsconnect: pre-compress main.wasm when building the NPM package
This way we can do that once (out of band, in the GitHub action),
instead of increasing the time of each deploy that uses the package.

.wasm is removed from the list of automatically pre-compressed
extensions, an OSS bump and small change on the corp side is needed to
make use of this change.

Signed-off-by: Mihai Parparita <mihai@tailscale.com>
2022-10-14 15:08:06 -07:00
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 2022-07-19 13:43:08 -07:00
src cmd/tsconnect: close the SSH session an unload event instead of beforeunload 2022-10-06 13:17:15 -07:00
wasm all: consistently initialize Logf when creating tsdial.Dialers 2022-09-30 14:40:56 -07:00
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 2022-08-24 17:29:52 -07:00
build-pkg.go cmd/tsconnect: pre-compress main.wasm when building the NPM package 2022-10-14 15:08:06 -07:00
build.go all: fix spelling mistakes 2022-09-29 13:36:13 -07:00
common.go all: fix more resource leaks found by staticmajor 2022-10-10 20:46:56 -07:00
dev-pkg.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
dev.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
index.html cmd/tsconnect: switch UI to Preact 2022-08-08 21:54:06 -07:00
package.json cmd/tsconnect: switch to non-beta versions of xterm and related packages 2022-10-04 15:51:36 -07:00
package.json.tmpl cmd/tsconnect: move NPM package to being under the @tailscale org 2022-10-12 13:18:45 -07:00
README.md cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
serve.go refactor: move from io/ioutil to io and os packages 2022-09-15 21:45:53 -07:00
tailwind.config.js cmd/tsconnect: switch UI to Preact 2022-08-08 21:54:06 -07:00
tsconfig.json cmd/tsconnect: switch UI to Preact 2022-08-08 21:54:06 -07:00
tsconnect.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
yarn.lock cmd/tsconnect: switch to non-beta versions of xterm and related packages 2022-10-04 15:51:36 -07:00

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.