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
Sonia Appasamy 5f40b8a0bc scripts/check_license_headers: enforce license on ts/tsx files
Enforcing inclusion of our OSS license at the top of .ts and .tsx
files. Also updates any relevant files in the repo that were
previously missing the license comment. An additional `@license`
comment is added to client/web/src/index.tsx to preserve the
license in generated Javascript.

Updates #10261

Signed-off-by: Sonia Appasamy <sonia@tailscale.com>
10 months ago
..
dist
src scripts/check_license_headers: enforce license on ts/tsx files 10 months ago
wasm cmd/tsconnect/wasm: add missing tstun.Wrapper.Start call 11 months ago
.gitignore
README.md
README.pkg.md
build-pkg.go all: adjust some build tags for plan9 1 year ago
build.go all: adjust some build tags for plan9 1 year ago
common.go go.mod,cmd/tsconnect: bump esbuild 12 months ago
dev-pkg.go all: adjust some build tags for plan9 1 year ago
dev.go all: adjust some build tags for plan9 1 year ago
index.html
package.json
package.json.tmpl
serve.go all: adjust some build tags for plan9 1 year ago
tailwind.config.js
tsconfig.json
tsconnect.go all: adjust some build tags for plan9 1 year ago
yarn.lock

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.