Home Explore Help
Sign In
Tailscale
/
tailscale
mirror of https://github.com/tailscale/tailscale.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: v1.95.0-pr
Branches Tags
tailscale
/
cmd
/
tsconnect
Brad Fitzpatrick bd29b189fe types/netmap,*: remove some redundant fields from NetMap 3 months ago
..
dist 6f5096fa61 cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 3 years ago
src 76b9afb54d ipn/store: make StateStore.All optional (#16409) 8 months ago
wasm bd29b189fe types/netmap,*: remove some redundant fields from NetMap 3 months ago
.gitignore 1a093ef482 cmd/tsconnect: extract NPM package for reusing in other projects 3 years ago
README.md 73d33e3f20 cmd/tsconnect: use empty string as the default state store key 3 years ago
README.pkg.md 660abd7309 cmd/tsconnect: add README to generated NPM package 3 years ago
build-pkg.go 98a5116434 all: adjust some build tags for plan9 2 years ago
build.go 2716250ee8 all: cleanup unused code, part 2 (#10670) 2 years ago
common.go 836c01258d go.toolchain.branch: update to Go 1.24 (#15016) 1 year ago
dev-pkg.go 98a5116434 all: adjust some build tags for plan9 2 years ago
dev.go 98a5116434 all: adjust some build tags for plan9 2 years ago
index.html ab159f748b cmd/tsconnect: switch UI to Preact 3 years ago
package.json 0039993359 cmd/tsconnect: update to xterm.js 5.1 3 years ago
package.json.tmpl 71029cea2d all: update copyright and license headers 3 years ago
serve.go 98a5116434 all: adjust some build tags for plan9 2 years ago
tailwind.config.js ab159f748b cmd/tsconnect: switch UI to Preact 3 years ago
tsconfig.json ab159f748b cmd/tsconnect: switch UI to Preact 3 years ago
tsconnect.go 60daa2adb8 all: fix golangci-lint errors 1 year ago
yarn.lock bcc262269f build(deps): bump braces from 3.0.2 to 3.0.3 in /cmd/tsconnect (#12468) 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.