chore: more docs cleanup/unification

This commit is contained in:
Aarnav Tale
2025-10-16 21:18:27 -04:00
parent 1b2d7e305a
commit 3b93f2fb61
6 changed files with 145 additions and 53 deletions
-4
View File
@@ -192,9 +192,6 @@ Keep in mind this won't work on its own as you'll need to configure Traefik
and TLS certificates as needed. This is just a snippet to show how to configure
the routing for Headplane and Headscale.
<details>
<summary>Traefik config snippet</summary>
```yaml
services:
# Same as before
@@ -262,5 +259,4 @@ services:
- '/var/run/docker.sock:/var/run/docker.sock:ro'
- '/path/to/certs/storage:/certs'
```
</details>
+29 -1
View File
@@ -1,4 +1,4 @@
---
--
title: Installation
description: Get started with Headplane.
---
@@ -20,3 +20,31 @@ is available to use as a starting point. Some of the important fields include:
| **`headscale.url`** | Point to your Headscale server (e.g., `http://headscale.example.com` or `http://headscale:8080` in Docker). |
| **`server.cookie_secret`** | Used to encrypt cookies. You can generate a random string using a command like `openssl rand -base64 32`. |
| **`server.data_path`** | Just a path to keep in mind, especially if you're using Docker. |
The configuration file is rather complicated and has many more options. Refer to
the [Configuration](../configuration.md) guide for a detailed explanation of all
the available options, as well as guidance on securely setting up your values
through secret path options and environment variables.
## Deployment Methods
Headplane can be deployed in several different ways, each with its own set of
advantages and trade-offs. Choose the method that best fits your needs:
### [Docker](./docker.md): Fast and easy deployment using Docker
- Recommended for most users due to its simplicity and ease of use.
- Allows for advanced features like network management and remote web SSH.
- Requires Docker and Docker Compose to be installed.
---
### [Native Mode](./native-mode.md): Direct installation on a server
- Suitable for users who prefer not to use Docker.
- Allows for advanced features like network management and remote web SSH.
- Requires manual setup of dependencies and environment.
---
### [Limited Mode](./limited-mode.md): Quick and easy deployment with minimal features
- Ideal for testing or simple environments and not intended for production use.
- Lacks any advanced functionality or integrations such as network management
or remote web SSH.
+3 -3
View File
@@ -43,8 +43,9 @@ It's important to mount your configuration file and also provide a persistent
storage location for Headplane to store its own data. You can also change the
port mapping if you want to run it on a different port.
<details>
<summary>Example Docker Compose configuration</summary>
### Optional: Docker Compose
If you prefer using Docker Compose, here is a minimal example of a
`compose.yaml` file that runs Headplane in Limited Mode:
```yaml
services:
@@ -58,7 +59,6 @@ services:
- '/path/to/your/config.yaml:/etc/headplane/config.yaml'
- '/path/to/data/storage:/var/lib/headplane'
```
</details>
## Accessing Headplane
+1 -7
View File
@@ -51,8 +51,7 @@ path by setting the `HEADPLANE_CONFIG_PATH` environment variable.
> Ensure that the `build/` directory exists relative to where the start command
> is run, otherwise Headplane will not be able to find the frontend assets.
<details>
<summary>Example Systemd service file</summary>
### Example systemd Service
Slotting this file into `/etc/systemd/system/headplane.service` will allow
you to manage Headplane via systemd. Adjust the paths and user as needed,
@@ -79,7 +78,6 @@ RestartSec=5s
[Install]
WantedBy=multi-user.target
```
</details>
To access Headplane, navigate to `http://localhost:3000/admin` in your web
browser (replace `localhost` with your server's IP address or domain name if
@@ -177,9 +175,6 @@ The following configuration will set up Nginx to proxy all Headscale requests
on `headscale.example.com` and serve the Headplane UI under the `/admin` path.
This is identical to how Tailscale's own admin console is served.
<details>
<summary>Nginx config snippet</summary>
```nginx
server {
listen 80;
@@ -223,7 +218,6 @@ server {
}
}
```
</details>
## Custom Path Prefix