tailscale/cmd/tsconnect
Andrew Lytvynov 2716250ee8
all: cleanup unused code, part 2 (#10670)
And enable U1000 check in staticcheck.

Updates #cleanup

Signed-off-by: Andrew Lytvynov <awly@tailscale.com>
2023-12-21 17:40:03 -08:00
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 2022-07-19 13:43:08 -07:00
src scripts/check_license_headers: enforce license on ts/tsx files 2023-11-28 13:57:09 -05:00
wasm cmd/tsconnect/wasm: add missing tstun.Wrapper.Start call 2023-10-18 17:24:02 -07:00
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 2022-08-24 17:29:52 -07:00
README.md cmd/tsconnect: use empty string as the default state store key 2023-01-30 17:18:41 -08:00
README.pkg.md cmd/tsconnect: add README to generated NPM package 2022-10-24 13:51:32 -07:00
build-pkg.go all: adjust some build tags for plan9 2023-08-24 15:42:35 -07:00
build.go all: cleanup unused code, part 2 (#10670) 2023-12-21 17:40:03 -08:00
common.go go.mod,cmd/tsconnect: bump esbuild 2023-09-29 14:28:45 -07:00
dev-pkg.go all: adjust some build tags for plan9 2023-08-24 15:42:35 -07:00
dev.go all: adjust some build tags for plan9 2023-08-24 15:42:35 -07:00
index.html cmd/tsconnect: switch UI to Preact 2022-08-08 21:54:06 -07:00
package.json cmd/tsconnect: update to xterm.js 5.1 2023-01-31 13:07:28 -08:00
package.json.tmpl all: update copyright and license headers 2023-01-27 15:36:29 -08:00
serve.go all: adjust some build tags for plan9 2023-08-24 15:42:35 -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 all: adjust some build tags for plan9 2023-08-24 15:42:35 -07:00
yarn.lock cmd/tsconnect: update to xterm.js 5.1 2023-01-31 13:07:28 -08:00

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.