mirror of
https://github.com/Drop-OSS/libtailscale-drop.git
synced 2026-02-04 15:01:18 +01:00
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# tailscale
|
|
|
|
The tailscale Python package provides an embedded network interface that can be
|
|
used to listen for and dial connections to other [Tailscale](https://tailscale.com) nodes.
|
|
|
|
## Build and Install
|
|
|
|
Build Requirements:
|
|
- Python 3.9 or greater
|
|
- A recent Go compiler in $PATH
|
|
- CMake (and a C compiler)
|
|
- Git
|
|
|
|
Start by creating a virtualenv:
|
|
|
|
$ python3 -m venv venv
|
|
$ source venv/bin/activate
|
|
|
|
Install build dependencies, build the c-archive, and install the Python package in your virtualenv:
|
|
|
|
$ make build
|
|
|
|
Run example echo server:
|
|
|
|
$ python3 examples/echo.py
|
|
|
|
Build a distributable wheel:
|
|
|
|
$ make wheel
|
|
=> tailscale-0.0.1-cp310-cp310-linux_x86_64.whl
|
|
|
|
## Usage
|
|
|
|
The node will need to be authorized in order to function. Set an auth key via
|
|
the `$TS_AUTHKEY` environment variable, with `TSNet.set_authkey`, or watch the log
|
|
stream and respond to the printed authorization URL.
|
|
|
|
## Contributing
|
|
|
|
Pull requests are welcome on GitHub at https://github.com/tailscale/libtailscale
|
|
|
|
Please file any issues about this code or the hosted service on
|
|
[the issue tracker](https://github.com/tailscale/tailscale/issues).
|