diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 57664d7..359ae25 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -7,7 +7,10 @@ export default defineConfig({
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
themeConfig: {
logo: '/logo.svg',
- nav: [{ text: 'Home', link: '/' }],
+ nav: [
+ { text: 'Home', link: '/' },
+ { text: 'Changelog', link: '/changelog' },
+ ],
sidebar: [
{
text: 'Getting Started',
@@ -25,9 +28,21 @@ export default defineConfig({
{ text: 'Configuration', link: '/Configuration' },
{ text: 'Nix', link: '/Nix' },
{ text: 'NixOS', link: '/NixOS-options' },
- { text: 'Security', link: '/SECURITY' },
- { text: 'Contributing', link: '/CONTRIBUTING' },
- { text: 'Changelog', link: '/CHANGELOG' },
+ {
+ text: 'Features',
+ items: [
+ { text: 'Single Sign-On (SSO)', link: '/features/sso' },
+ { text: 'Headplane Agent / SSH', link: '/features/agent' },
+ ],
+ },
+ {
+ text: 'Development',
+ collapsed: true,
+ items: [
+ { text: 'Contributing', link: '/contributing' },
+ { text: 'Security', link: '/security' },
+ ],
+ },
],
},
],
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
index dc66c52..3eb0162 100644
--- a/docs/.vitepress/theme/custom.css
+++ b/docs/.vitepress/theme/custom.css
@@ -5,3 +5,13 @@ html.dark .light-only {
html:not(.dark) .dark-only {
display: none !important;
}
+
+figure {
+ padding: 1em;
+}
+
+figcaption {
+ text-align: center;
+ font-size: 0.9em;
+ margin-top: 0.5em;
+}
diff --git a/docs/assets/acls-dark.png b/docs/assets/acls-dark.png
index c778814..44a7f94 100644
Binary files a/docs/assets/acls-dark.png and b/docs/assets/acls-dark.png differ
diff --git a/docs/assets/acls-light.png b/docs/assets/acls-light.png
index b8f1a8e..22a0527 100644
Binary files a/docs/assets/acls-light.png and b/docs/assets/acls-light.png differ
diff --git a/docs/assets/dns-dark.png b/docs/assets/dns-dark.png
index 5ac108b..e45d640 100644
Binary files a/docs/assets/dns-dark.png and b/docs/assets/dns-dark.png differ
diff --git a/docs/assets/dns-light.png b/docs/assets/dns-light.png
index 35ec39b..503f4be 100644
Binary files a/docs/assets/dns-light.png and b/docs/assets/dns-light.png differ
diff --git a/docs/assets/machine-dark.png b/docs/assets/machine-dark.png
index 1ea748b..1f55819 100644
Binary files a/docs/assets/machine-dark.png and b/docs/assets/machine-dark.png differ
diff --git a/docs/assets/machine-light.png b/docs/assets/machine-light.png
index 0aae488..0f2fec8 100644
Binary files a/docs/assets/machine-light.png and b/docs/assets/machine-light.png differ
diff --git a/docs/assets/preview-dark.png b/docs/assets/preview-dark.png
index 10b66fa..689bf57 100644
Binary files a/docs/assets/preview-dark.png and b/docs/assets/preview-dark.png differ
diff --git a/docs/assets/preview-light.png b/docs/assets/preview-light.png
index ffdf41c..7937edf 100644
Binary files a/docs/assets/preview-light.png and b/docs/assets/preview-light.png differ
diff --git a/docs/assets/ssh.png b/docs/assets/ssh.png
new file mode 100644
index 0000000..3ca28f7
Binary files /dev/null and b/docs/assets/ssh.png differ
diff --git a/docs/assets/sso-dark.png b/docs/assets/sso-dark.png
new file mode 100644
index 0000000..0f97a3f
Binary files /dev/null and b/docs/assets/sso-dark.png differ
diff --git a/docs/assets/sso-light.png b/docs/assets/sso-light.png
new file mode 100644
index 0000000..8d0a3c7
Binary files /dev/null and b/docs/assets/sso-light.png differ
diff --git a/docs/features/agent.md b/docs/features/agent.md
index fc06cf2..3b51052 100644
--- a/docs/features/agent.md
+++ b/docs/features/agent.md
@@ -4,4 +4,10 @@ description: Configure the Headplane Agent for enhanced functionality.
---
# Headplane Agent
+
+
+ 
+ SSH access via the browser
+
+
TODO
diff --git a/docs/features/sso.md b/docs/features/sso.md
index e9be232..f8c4abf 100644
--- a/docs/features/sso.md
+++ b/docs/features/sso.md
@@ -4,4 +4,11 @@ description: Configure Single Sign-On (SSO) authentication for Headplane.
---
# Single Sign-On (SSO)
+
+
+ 
+ 
+ SSO Configuration Page
+
+
TODO
diff --git a/docs/getting-started.md b/docs/getting-started.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/install/index.md b/docs/install/index.md
index d81863a..02aee9c 100644
--- a/docs/install/index.md
+++ b/docs/install/index.md
@@ -1,6 +1,7 @@
---
+---
title: Installation
description: Get started with Headplane.
+outline: [2, 3]
---
# Installation
diff --git a/docs/introduction.md b/docs/introduction.md
index 4fb3fa3..dc82683 100644
--- a/docs/introduction.md
+++ b/docs/introduction.md
@@ -10,8 +10,11 @@ feature-rich VPN platform that rivals Tailscale's official offering. Headscale
is a self-hosted implementation of the Tailscale control server, enabling users
to create and manage their own private VPN networks via the Tailscale client.
-
-
+
+
+
+ Headplane Dashboard
+
Headscale does not ship with any web UI by default, which is where Headplane
comes in. Headplane provides a comprehensive web interface for managing your
@@ -24,8 +27,11 @@ Connect (OIDC), and detailed insights into your Tailnet's configuration and
status. Things like DNS management, ACL editing, and Headscale configuration can
all be done directly from the Headplane UI when compared to other Headscale UIs.
-
-
+
+
+
+ DNS management in Headplane
+
Headplane aims to replicate the functionality offered by the official Tailscale
product and dashboard, being one of the most feature complete Headscale UIs available.
@@ -36,3 +42,9 @@ These are some of the features that Headplane offers:
- Support for OpenID Connect (OIDC) as a login provider
- The ability to edit DNS settings and automatically provision Headscale
- Configurability for Headscale's settings
+
+
+ 
+ 
+ Machine management in Headplane
+