mirror of
https://github.com/tailscale/tailscale.git
synced 2024-11-29 13:05:46 +00:00
d74c771fda
This uses the new react-based web client for all builds, not just with the --dev flag. If the web client assets have not been built, the client will serve a message that Tailscale was built without the web client, and link to build instructions. Because we will include the web client in all of our builds, this should only be seen by developers or users building from source. (And eventually this will be replaced by attempting to download needed assets as runtime.) We do now checkin the build/index.html file, which serves the error message when assets are unavailable. This will also eventually be used to trigger in CI when new assets should be built and uploaded to a well-known location. Updates tailscale/corp#13775 Signed-off-by: Will Norris <will@tailscale.com>
100 lines
3.2 KiB
Markdown
100 lines
3.2 KiB
Markdown
# Tailscale
|
|
|
|
https://tailscale.com
|
|
|
|
Private WireGuard® networks made easy
|
|
|
|
## Overview
|
|
|
|
This repository contains the majority of Tailscale's open source code.
|
|
Notably, it includes the `tailscaled` daemon and
|
|
the `tailscale` CLI tool. The `tailscaled` daemon runs on Linux, Windows,
|
|
[macOS](https://tailscale.com/kb/1065/macos-variants/), and to varying degrees
|
|
on FreeBSD and OpenBSD. The Tailscale iOS and Android apps use this repo's
|
|
code, but this repo doesn't contain the mobile GUI code.
|
|
|
|
Other [Tailscale repos](https://github.com/orgs/tailscale/repositories) of note:
|
|
|
|
* the Android app is at https://github.com/tailscale/tailscale-android
|
|
* the Synology package is at https://github.com/tailscale/tailscale-synology
|
|
* the QNAP package is at https://github.com/tailscale/tailscale-qpkg
|
|
* the Chocolatey packaging is at https://github.com/tailscale/tailscale-chocolatey
|
|
|
|
For background on which parts of Tailscale are open source and why,
|
|
see [https://tailscale.com/opensource/](https://tailscale.com/opensource/).
|
|
|
|
## Using
|
|
|
|
We serve packages for a variety of distros and platforms at
|
|
[https://pkgs.tailscale.com](https://pkgs.tailscale.com/).
|
|
|
|
## Other clients
|
|
|
|
The [macOS, iOS, and Windows clients](https://tailscale.com/download)
|
|
use the code in this repository but additionally include small GUI
|
|
wrappers. The GUI wrappers on non-open source platforms are themselves
|
|
not open source.
|
|
|
|
## Building
|
|
|
|
We always require the latest Go release, currently Go 1.21. (While we build
|
|
releases with our [Go fork](https://github.com/tailscale/go/), its use is not
|
|
required.)
|
|
|
|
```
|
|
go install tailscale.com/cmd/tailscale{,d}
|
|
```
|
|
|
|
If you're packaging Tailscale for distribution, use `build_dist.sh`
|
|
instead, to burn commit IDs and version info into the binaries:
|
|
|
|
```
|
|
./build_dist.sh tailscale.com/cmd/tailscale
|
|
./build_dist.sh tailscale.com/cmd/tailscaled
|
|
```
|
|
|
|
If your distro has conventions that preclude the use of
|
|
`build_dist.sh`, please do the equivalent of what it does in your
|
|
distro's way, so that bug reports contain useful version information.
|
|
|
|
## Building the web client
|
|
|
|
To include the embedded web client (accessed via the `tailscale web` command),
|
|
you'll need to build the client assets using:
|
|
|
|
```
|
|
./tool/yarn --cwd client/web build
|
|
```
|
|
|
|
Do this before building the `tailscale.com/cmd/tailscale` binary.
|
|
|
|
## Bugs
|
|
|
|
Please file any issues about this code or the hosted service on
|
|
[the issue tracker](https://github.com/tailscale/tailscale/issues).
|
|
|
|
## Contributing
|
|
|
|
PRs welcome! But please file bugs. Commit messages should [reference
|
|
bugs](https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls).
|
|
|
|
We require [Developer Certificate of
|
|
Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin)
|
|
`Signed-off-by` lines in commits.
|
|
|
|
See `git log` for our commit message style. It's basically the same as
|
|
[Go's style](https://github.com/golang/go/wiki/CommitMessage).
|
|
|
|
## About Us
|
|
|
|
[Tailscale](https://tailscale.com/) is primarily developed by the
|
|
people at https://github.com/orgs/tailscale/people. For other contributors,
|
|
see:
|
|
|
|
* https://github.com/tailscale/tailscale/graphs/contributors
|
|
* https://github.com/tailscale/tailscale-android/graphs/contributors
|
|
|
|
## Legal
|
|
|
|
WireGuard is a registered trademark of Jason A. Donenfeld.
|