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
Brad Fitzpatrick 9a86aa5732 all: depend on zstd unconditionally, remove plumbing to make it optional
All platforms use it at this point, including iOS which was the
original hold out for memory reasons. No more reason to make it
optional.

Updates #9332

Change-Id: I743fbc2f370921a852fbcebf4eb9821e2bdd3086
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
9 months ago
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 2 years ago
src cmd/tsconnect: pop CTA to make everything work with tailnet lock 1 year ago
wasm all: depend on zstd unconditionally, remove plumbing to make it optional 9 months ago
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 2 years ago
README.md cmd/tsconnect: use empty string as the default state store key 1 year ago
README.pkg.md cmd/tsconnect: add README to generated NPM package 2 years ago
build-pkg.go all: adjust some build tags for plan9 9 months ago
build.go all: adjust some build tags for plan9 9 months ago
common.go all: adjust some build tags for plan9 9 months ago
dev-pkg.go all: adjust some build tags for plan9 9 months ago
dev.go all: adjust some build tags for plan9 9 months ago
index.html cmd/tsconnect: switch UI to Preact 2 years ago
package.json cmd/tsconnect: update to xterm.js 5.1 1 year ago
package.json.tmpl all: update copyright and license headers 1 year ago
serve.go all: adjust some build tags for plan9 9 months 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 all: adjust some build tags for plan9 9 months ago
yarn.lock cmd/tsconnect: update to xterm.js 5.1 1 year 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, CSS and Go wasm package changes can be picked up with a browser reload. Server-side Go changes require the server to be stopped and restarted. In development mode the state the Tailscale client state 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.