2020-02-10 19:56:04 +00:00
# Tailscale
2020-02-10 22:01:37 +00:00
https://tailscale.com
2020-02-10 19:56:04 +00:00
Private WireGuard® networks made easy
## Overview
2020-08-07 15:25:25 +00:00
This repository contains all the open source Tailscale client code and
the `tailscaled` daemon and `tailscale` CLI tool. The `tailscaled`
2021-11-17 14:40:36 +00:00
daemon runs on Linux, Windows and [macOS ](https://tailscale.com/kb/1065/macos-variants/ ), and to varying degrees on FreeBSD, OpenBSD, and Darwin. (The Tailscale iOS and Android apps use this repo's code, but this repo doesn't contain the mobile GUI code.)
2020-02-10 19:56:04 +00:00
2020-08-07 15:25:25 +00:00
The Android app is at https://github.com/tailscale/tailscale-android
2020-02-10 19:56:04 +00:00
2021-11-17 14:40:36 +00:00
The Synology package is at https://github.com/tailscale/tailscale-synology
2020-03-02 21:52:51 +00:00
## Using
We serve packages for a variety of distros at
https://pkgs.tailscale.com .
2020-08-07 15:25:25 +00:00
## Other clients
The [macOS, iOS, and Windows clients ](https://tailscale.com/download )
use the code in this repository but additionally include small GUI
wrappers that are not open source.
2020-02-10 19:56:04 +00:00
## Building
```
go install tailscale.com/cmd/tailscale{,d}
```
2020-10-27 04:23:58 +00:00
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.
2022-08-02 18:34:03 +00:00
We require the latest Go release, currently Go 1.19.
2020-02-10 22:01:37 +00:00
2020-02-10 19:56:04 +00:00
## Bugs
2020-02-10 22:01:37 +00:00
Please file any issues about this code or the hosted service on
[the issue tracker ](https://github.com/tailscale/tailscale/issues ).
2020-02-10 19:56:04 +00:00
## Contributing
2020-08-07 15:28:56 +00:00
PRs welcome! But please file bugs. Commit messages should [reference
bugs](https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls).
2020-02-10 22:01:37 +00:00
We require [Developer Certificate of
Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin)
`Signed-off-by` lines in commits.
2020-02-10 19:56:04 +00:00
## About Us
2021-01-12 16:24:24 +00:00
[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
2020-02-10 19:56:04 +00:00
WireGuard is a registered trademark of Jason A. Donenfeld.
