34 lines
1.9 KiB
Markdown
34 lines
1.9 KiB
Markdown
# Headplane Agent
|
|
|
|
> This is currently not available in Headplane.
|
|
> It is incomplete and will land within the next few releases.
|
|
|
|
The Headplane agent is a lightweight service that runs alongside the Headscale server.
|
|
It's used to interface with devices on your network locally, unlocking the following:
|
|
|
|
- **Node Information/Status**: View Tailscale versions, OS versions, and connection details.
|
|
- **SSH via Web (Soon)**: Connect to devices via SSH directly from the Headplane UI.
|
|
|
|
It's built on top of [tsnet](https://tailscale.com/kb/1244/tsnet), the official
|
|
set of libraries published by Tailscale for creating local services that can
|
|
join the tailnet.
|
|
While it isn't required to run the agent, it's highly recommended to get the
|
|
closest experience to the SaaS version of Tailscale. This is paired with the
|
|
integrations provided by Headplane to manage DNS and Headscale settings.
|
|
|
|
### Installation
|
|
The agent can either be ran as a standalone binary or as a Docker container.
|
|
Agent binaries are available on the [releases](https://github.com/tale/headplane/releases) page.
|
|
The Docker image is available through the `ghcr.io/tale/headplane-agent` tag.
|
|
|
|
The agent requires the following environment variables to be set:
|
|
- **`HEADPLANE_AGENT_DEBUG`**: Enable debug logging if `true`.
|
|
- **`HEADPLANE_AGENT_HOSTNAME`**: A hostname you want to use for the agent.
|
|
- **`HEADPLANE_AGENT_TS_SERVER`**: The URL to your Headscale instance.
|
|
- **`HEADPLANE_AGENT_TS_AUTHKEY`**: An authorization key to authenticate with Headscale (see below).
|
|
- **`HEADPLANE_AGENT_HP_SERVER`**: The URL to your Headplane instance, including the subpath (eg. `https://headplane.example.com/admin`).
|
|
- **`HEADPLANE_AGENT_HP_AUTHKEY`**: The generated auth key to authenticate with Headplane.
|
|
|
|
If you already have Headplane setup, you can generate all of these values within
|
|
the Headplane UI. Navigate to the `Settings` page and click `Agent` to get started.
|