tailscale/cmd/tsconnect
Eng Zer Jun f0347e841f refactor: move from io/ioutil to io and os packages
The io/ioutil package has been deprecated as of Go 1.16 [1]. This commit
replaces the existing io/ioutil functions with their new definitions in
io and os packages.

Reference: https://golang.org/doc/go1.16#ioutil
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-09-15 21:45:53 -07:00
..
dist cmd/tsconnect: initial scaffolding for Tailscale Connect browser client 2022-07-19 13:43:08 -07:00
src cmd/tsconnect: use the parent window for beforeunload event listener 2022-09-14 11:35:13 -07:00
wasm cmd/tsconnect: allow hostname to be specified 2022-09-12 14:26:50 -07:00
.gitignore cmd/tsconnect: extract NPM package for reusing in other projects 2022-08-24 17:29:52 -07:00
build-pkg.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
build.go refactor: move from io/ioutil to io and os packages 2022-09-15 21:45:53 -07:00
common.go refactor: move from io/ioutil to io and os packages 2022-09-15 21:45:53 -07:00
dev-pkg.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
dev.go cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
index.html cmd/tsconnect: switch UI to Preact 2022-08-08 21:54:06 -07:00
package.json cmd/tsconnect: enable web links addon in the terminal 2022-09-09 11:05:01 -07:00
package.json.tmpl cmd/tsconnect: add npm publish workflow 2022-08-29 18:02:51 -07:00
README.md cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
serve.go refactor: move from io/ioutil to io and os packages 2022-09-15 21:45:53 -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 cmd/tsconnect: add dev-pkg command for two-sided development 2022-09-06 12:42:58 -07:00
yarn.lock cmd/tsconnect: enable web links addon in the terminal 2022-09-09 11:05:01 -07:00

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 and CSS changes can be picked up with a browser reload. Go changes (including to the wasm package) require the server to be stopped and restarted. In development mode the state the Tailscale client 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.