mirror of
https://github.com/tale/headplane.git
synced 2026-08-24 11:36:31 +00:00
chore: more docs cleanup/unification
This commit is contained in:
+29
-1
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user