tsconnect
commandThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
README¶
tsconnect
The tsconnect command builds and serves the static site that is generated forthe Tailscale Connect JS/WASM client.
Development
To start the development server:
./tool/go run ./cmd/tsconnect devThe site is served athttp://localhost:9090/. JavaScript, CSS and Gowasm 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 insessionStorage 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 buildTo serve them, run:
./tool/go run ./cmd/tsconnect serveBy default the build output is placed in thedist/ 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 asan NPM package. To build it, run:
./tool/go run ./cmd/tsconnect build-pkgThat places the output in thepkg/ 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-pkgThis serves the module athttp://localhost:9090/pkg/pkg.js and the generated wasm file athttp://localhost:9090/pkg/main.wasm. The two files can be used as drop-in replacements for normal imports of the NPM module.
Documentation¶
Overview¶
The tsconnect command builds and serves the static site that is generated forthe Tailscale Connect JS/WASM client. Can be run in 3 modes:
- dev: builds the site and serves it. JS and CSS changes can be picked upwith a reload.
- build: builds the site and writes it to dist/
- serve: serves the site from dist/ (embedded in the binary)