Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/config/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"position": 4,
"link": {
"type": "generated-index",
"description": "Configuration options for Nebula.",
"description": "Complete reference for all Nebula configuration options including PKI, firewall rules, lighthouse, relay, tun, and more.",
"slug": "/config"
}
}
2 changes: 1 addition & 1 deletion docs/guides/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"position": 2,
"link": {
"type": "generated-index",
"description": "A collection of how-to guides that explain how to use various capabilities of the Nebula overlay networking tool.",
"description": "Step-by-step guides for configuring and troubleshooting Nebula overlay networks, including quick start, certificate management, DNS, and routing.",
"slug": "/guides"
}
}
2 changes: 2 additions & 0 deletions docs/guides/debug-ssh-commands/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Debugging with Nebula SSH commands
description:
Learn how to use Nebula's built-in SSH server commands to debug network connectivity issues on overlay hosts.
summary:
This guide describes useful commands built into the SSH server accessible over nebula, which can allow debugging
network connectivity for the nebula host.
Expand Down
3 changes: 1 addition & 2 deletions docs/guides/quick-start/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Quick Start
description:
'Nebula Docs: How to create your first overlay network using a Certificate Authority, Lighthouse, and Hosts'
description: How to create your first overlay network using a Certificate Authority, Lighthouse, and Hosts
summary:
This section will walk you through setting up a simple nebula network for testing. The examples will need to be
modified to suit your particular environment.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/rotating-certificate-authority/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Rotating a Certificate Authority
description: 'Nebula Docs: How to rotate an expiring certificate authority without downtime.'
description: How to rotate an expiring Nebula certificate authority without downtime.
summary:
This guide will teach you how to migrate from an expiring certificate authority by creating a new certificate
authority, updating your device's Nebula config to trust the new authority, signing new host certificates, and
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/sign-certificates-with-public-keys/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Signing a Certificate Without a Private Key
description: 'Nebula Docs: How to sign certificates without copying private keys across devices.'
description: How to sign Nebula certificates without copying private keys across devices.
summary:
After reading this guide you will be able to create public/private keypairs on devices you wish to add to the Nebula
network and generate certificates for them using only the public key.
Expand Down
3 changes: 3 additions & 0 deletions docs/guides/unsafe_routes/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Extend network access beyond overlay hosts
description:
Configure Nebula unsafe_routes to route traffic through overlay hosts and reach devices that cannot run Nebula
directly.
summary:
This guide explains how to configure Nebula to route traffic destined for a specific subnet through a specific overlay
network host, which is useful for accessing hosts that cannot be modified to run Nebula.
Expand Down
3 changes: 3 additions & 0 deletions docs/guides/upgrade-to-cert-v2-and-ipv6/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Upgrading a Nebula network to IPv6 overlay addresses
description:
Step-by-step guide to upgrading an existing Nebula network to the v2 certificate format and enabling IPv6 overlay
addresses.
summary:
This guide describes how to upgrade an existing nebula network to the v2 certificate format and enable IPv6 addresses.
---
Expand Down
6 changes: 6 additions & 0 deletions docs/guides/using-lighthouse-dns/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Using Lighthouse DNS with Nebula
description:
Configure Nebula's experimental built-in DNS server on Lighthouse hosts to resolve overlay network hostnames.
---

# Using Experimental Lighthouse DNS with Nebula

:::warning
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/viewing-nebula-logs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Viewing Nebula Logs
description: How to view Nebula logs on Linux, macOS, Windows, iOS, and Android for troubleshooting and monitoring.
---

import ThemedImage from '@theme/ThemedImage';

# Viewing Nebula Logs
Expand Down
3 changes: 3 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Introduction to Nebula
description:
Nebula is an open source overlay networking tool for building fast, secure, and scalable networks. Connect hosts with
encrypted tunnels across any IP network.
slug: /
sidebar_position: 1
---
Expand Down
2 changes: 1 addition & 1 deletion docs/security/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"position": 3,
"link": {
"type": "generated-index",
"description": "Security bulletins for Nebula.",
"description": "Security bulletins for the Nebula overlay networking tool.",
"slug": "/security"
}
}
5 changes: 3 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ if (process.env.GTAG_TRACKING_ID) {

const config: Config = {
title: 'Nebula Docs',
tagline: 'Learn about Nebula here',
tagline: 'Documentation for Nebula, an open source overlay networking tool',
url: 'https://nebula.defined.net',
// For deploy previews, don't set a baseUrl
baseUrl: '/',
Expand Down Expand Up @@ -79,8 +79,9 @@ const config: Config = {

themeConfig: {
image: 'img/nebula-docs-og.png',
metadata: [{ name: 'keywords', content: 'nebula, overlay network, VPN, mesh networking, defined networking' }],
navbar: {
title: '',
title: 'Nebula Documentation',
logo: {
alt: 'Nebula logo',
href: '/docs/',
Expand Down
6 changes: 6 additions & 0 deletions src/css/utility.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
.mb-24 {
margin-bottom: 24px;
}

/* Hide navbar title visually while keeping it in the DOM for crawlers */

.navbar__title {
display: none;
}
4 changes: 4 additions & 0 deletions static/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
User-agent: *
Allow: /

Sitemap: https://nebula.defined.net/sitemap.xml