|
2 | 2 |
|
3 | 3 | A modern and fast implementation of tailscale-systray in Rust.
|
4 | 4 |
|
5 |
| -> [!NOTE] Tailray is a work in progress. Most things don't work, or work in a |
6 |
| -> degraded state. If you find bugs that are not aggressed in the issues tab, |
7 |
| -> feel free to create a new issue or a pull request! You are advi |
| 5 | +<!-- deno-fmt-ignore-start --> |
| 6 | + |
| 7 | +## Usage |
| 8 | + |
| 9 | +> [!NOTE] |
| 10 | +> Tailray is a work in progress. Most things don't work, or work in a |
| 11 | +> degraded state. If you find bugs that are not addressed in the issues tab, |
| 12 | +> feel free to create a new issue or a pull request! |
| 13 | +
|
| 14 | +<!-- deno-fmt-ignore-end --> |
| 15 | + |
| 16 | +Tailray requires Tailscaled to be up and running. On Linux systems, you can |
| 17 | +check its status with `systemctl status tailscaled`. |
| 18 | + |
| 19 | +After you confirm that Tailscale is running, and that you are authenticated run |
| 20 | +`tailray` from a terminal or consider writing a systemd service for it. |
| 21 | + |
| 22 | +### Overriding Admin Console URL |
| 23 | + |
| 24 | +Tailray will assume `https://login.tailscale.com/admin/machines` to be the Admin |
| 25 | +Console URL by default. You may override this URL by setting `TAILRAY_ADMIN_URL` |
| 26 | +to an URL of your choice. |
8 | 27 |
|
9 | 28 | ## Hacking
|
10 | 29 |
|
11 |
| -Simply run `nix develop` in the project root. |
| 30 | +The recommended way of building Tailray is with the Nix build tool. You may run |
| 31 | +`nix develop` in the repository to enter a devShell with the necessary |
| 32 | +dependencies. Direnv users may also use `direnv allow` to let direnv handle |
| 33 | +their shell environment. |
12 | 34 |
|
13 | 35 | ## License
|
14 | 36 |
|
|
0 commit comments