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
Nick Khyl 892f8a9582 various: allow tailscaled shutdown via LocalAPI
A customer wants to allow their employees to restart tailscaled at will, when access rights and MDM policy allow it,
as a way to fully reset client state and re-create the tunnel in case of connectivity issues.

On Windows, the main tailscaled process runs as a child of a service process. The service restarts the child
when it exits (or crashes) until the service itself is stopped. Regular (non-admin) users can't stop the service,
and allowing them to do so isn't ideal, especially in managed or multi-user environments.

In this PR, we add a LocalAPI endpoint that instructs ipnserver.Server, and by extension the tailscaled process,
to shut down. The service then restarts the child tailscaled. Shutting down tailscaled requires LocalAPI write access
and an enabled policy setting.

Updates tailscale/corp#32674
Updates tailscale/corp#32675

Signed-off-by: Nick Khyl <nickk@tailscale.com>
2 months ago
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 3 years ago
src ipn/store: make StateStore.All optional (#16409) 5 months ago
wasm various: allow tailscaled shutdown via LocalAPI 2 months ago
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 3 years ago
README.md cmd/tsconnect: use empty string as the default state store key 3 years ago
README.pkg.md cmd/tsconnect: add README to generated NPM package 3 years ago
build-pkg.go all: adjust some build tags for plan9 2 years ago
build.go all: cleanup unused code, part 2 (#10670) 2 years ago
common.go go.toolchain.branch: update to Go 1.24 (#15016) 10 months ago
dev-pkg.go all: adjust some build tags for plan9 2 years ago
dev.go all: adjust some build tags for plan9 2 years ago
index.html cmd/tsconnect: switch UI to Preact 3 years ago
package.json cmd/tsconnect: update to xterm.js 5.1 3 years ago
package.json.tmpl all: update copyright and license headers 3 years ago
serve.go all: adjust some build tags for plan9 2 years ago
tailwind.config.js cmd/tsconnect: switch UI to Preact 3 years ago
tsconfig.json cmd/tsconnect: switch UI to Preact 3 years ago
tsconnect.go all: fix golangci-lint errors 11 months ago
yarn.lock build(deps): bump braces from 3.0.2 to 3.0.3 in /cmd/tsconnect (#12468) 11 months 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.