Skip to content

Commit 1b2d7e3

Browse files
committed
docs: new installation docs!
1 parent 639e7e9 commit 1b2d7e3

15 files changed

Lines changed: 693 additions & 347 deletions

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,7 @@ These are some of the features that Headplane offers:
3232
- Configurability for Headscale's settings
3333

3434
## Deployment
35-
Headplane runs as a server-based web-application, meaning you'll need a server to run it.
36-
It's available as a Docker image (recommended) or through a manual installation.
37-
There are 2 ways to deploy Headplane:
38-
39-
- ### [Integrated Mode (Recommended)](/docs/Integrated-Mode.md)
40-
Integrated mode unlocks all the features of Headplane and is the most
41-
feature-complete deployment method. It communicates with Headscale directly.
42-
43-
- ### [Simple Mode](/docs/Simple-Mode.md)
44-
Simple mode does not include the automatic management of DNS and Headplane
45-
settings, requiring manual editing and reloading when making changes.
35+
Refer to the [website](https://headplane.net) for detailed installation instructions.
4636

4737
## Versioning
4838
Headplane uses [semantic versioning](https://semver.org/) for its releases (since v0.6.0).

docs/.vitepress/config.ts

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,26 @@ import { defineConfig } from 'vitepress';
33
export default defineConfig({
44
title: 'Headplane',
55
description: 'The missing dashboard for Headscale',
6-
ignoreDeadLinks: ['/docs/Integrated-Mode', '/docs/Simple-Mode'],
76
cleanUrls: true,
87
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
98
themeConfig: {
109
logo: '/logo.svg',
1110
nav: [{ text: 'Home', link: '/' }],
1211
sidebar: [
1312
{
14-
text: 'Chapters',
13+
text: 'Getting Started',
1514
items: [
16-
{ text: 'Getting Started', link: '/README' },
15+
{ text: 'What is Headplane?', link: '/introduction' },
16+
{
17+
text: 'Installation',
18+
link: '/install',
19+
items: [
20+
{ text: 'Limited Mode', link: '/install/limited-mode' },
21+
{ text: 'Native Mode', link: '/install/native-mode' },
22+
{ text: 'Docker', link: '/install/docker' },
23+
],
24+
},
1725
{ text: 'Configuration', link: '/Configuration' },
18-
{ text: 'Bare-Metal Mode', link: '/Bare-Metal' },
19-
{ text: 'Integrated Mode', link: '/Integrated-Mode' },
20-
{ text: 'Simple Mode', link: '/Simple-Mode' },
2126
{ text: 'Nix', link: '/Nix' },
2227
{ text: 'NixOS', link: '/NixOS-options' },
2328
{ text: 'Security', link: '/SECURITY' },

docs/Bare-Metal.md

Lines changed: 0 additions & 92 deletions
This file was deleted.

docs/Integrated-Mode.md

Lines changed: 0 additions & 199 deletions
This file was deleted.

docs/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/Simple-Mode.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/features/agent.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Headplane Agent
3+
description: Configure the Headplane Agent for enhanced functionality.
4+
---
5+
6+
# Headplane Agent
7+
TODO

0 commit comments

Comments
 (0)