diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index b36c866e..d74dee03 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -23,12 +23,11 @@ jobs: wget https://raw.githubusercontent.com/netbootxyz/netboot.xyz/master/CHANGELOG.md -O external/changelog.md wget https://raw.githubusercontent.com/netbootxyz/build-pipelines/master/README.md -O external/build-automation.md wget https://raw.githubusercontent.com/netbootxyz/netboot.xyz/master/CONTRIBUTING.md -O external/contributing.md - curl https://raw.githubusercontent.com/netbootxyz/docker-netbootxyz/master/README.md | tail -n+7 > external/docker.md - name: Setup Node.js uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 22 - name: Install dependencies run: yarn install diff --git a/docs/booting/_category_.yml b/docs/booting/_category_.yml new file mode 100644 index 00000000..4d4243b8 --- /dev/null +++ b/docs/booting/_category_.yml @@ -0,0 +1,6 @@ +label: Booting Methods +position: 3 +link: + type: generated-index + title: Booting Methods + description: Select your desired netboot.xyz boot method below... diff --git a/docs/booting/grub.md b/docs/booting/grub.md index 9e47dab7..c7f9e18b 100644 --- a/docs/booting/grub.md +++ b/docs/booting/grub.md @@ -1,7 +1,8 @@ --- id: grub title: Booting from an existing Linux installation using GRUB -sidebar_label: Booting from GRUB +sidebar_label: GRUB +sidebar_position: 5 description: "How to use GRUB to boot into netboot.xyz" hide_table_of_contents: true --- diff --git a/docs/booting/ipxe.md b/docs/booting/ipxe.md index c89f401d..399419c2 100644 --- a/docs/booting/ipxe.md +++ b/docs/booting/ipxe.md @@ -1,7 +1,8 @@ --- id: ipxe -title: Boot using iPXE -sidebar_label: Boot using iPXE +title: iPXE +sidebar_label: iPXE +sidebar_position: 4 description: "Details how to chainload into netboot.xyz from iPXE" hide_table_of_contents: true --- diff --git a/docs/booting/iso.md b/docs/booting/iso.md index 1773c849..9b92f035 100644 --- a/docs/booting/iso.md +++ b/docs/booting/iso.md @@ -1,7 +1,8 @@ --- id: iso -title: Booting with an ISO -sidebar_label: Booting with an ISO +title: ISO +sidebar_label: ISO +sidebar_position: 2 description: "How to use an ISO to boot into netboot.xyz" hide_table_of_contents: true --- diff --git a/docs/booting/qemu.md b/docs/booting/qemu.md index ade5aeef..76c48ae9 100644 --- a/docs/booting/qemu.md +++ b/docs/booting/qemu.md @@ -1,7 +1,8 @@ --- id: qemu -title: Booting from QEMU -sidebar_label: Booting from QEMU +title: QEMU +sidebar_label: QEMU +sidebar_position: 6 description: "Methods of booting into netboot.xyz using QEMU" hide_table_of_contents: true --- diff --git a/docs/booting/tftp.md b/docs/booting/tftp.md index 6b5ee6bc..99aa9ee2 100644 --- a/docs/booting/tftp.md +++ b/docs/booting/tftp.md @@ -1,7 +1,8 @@ --- id: tftp -title: Booting from TFTP -sidebar_label: Booting from TFTP +title: TFTP +sidebar_label: TFTP +sidebar_position: 3 description: "Methods of booting into netboot.xyz using TFTP and DHCP" hide_table_of_contents: true --- diff --git a/docs/booting/usb.md b/docs/booting/usb.md index 28612262..3c49995c 100644 --- a/docs/booting/usb.md +++ b/docs/booting/usb.md @@ -1,7 +1,8 @@ --- id: usb -title: Booting from USB -sidebar_label: Booting from USB +title: USB +sidebar_label: USB +sidebar_position: 1 description: "How to create a USB stick capable of booting into netboot.xyz" hide_table_of_contents: true --- diff --git a/docs/booting/vmware.md b/docs/booting/vmware.md index b203f5fb..09a02b5b 100644 --- a/docs/booting/vmware.md +++ b/docs/booting/vmware.md @@ -1,7 +1,8 @@ --- id: vmware -title: Boot using VMware -sidebar_label: Boot using VMware +title: VMware +sidebar_label: VMware +sidebar_position: 7 description: "Using netboot.xyz in VMware to install a VM" hide_table_of_contents: true --- diff --git a/docs/community/_category_.yml b/docs/community/_category_.yml new file mode 100644 index 00000000..a9c5a563 --- /dev/null +++ b/docs/community/_category_.yml @@ -0,0 +1,6 @@ +label: Community +position: 5 +collapsed: true +link: + type: generated-index + title: Community diff --git a/docs/community/nbxyz-users.md b/docs/community/nbxyz-users.md index e1e9d1b8..fcd6ec2b 100644 --- a/docs/community/nbxyz-users.md +++ b/docs/community/nbxyz-users.md @@ -35,6 +35,7 @@ hide_table_of_contents: true ## Open Source Projects +- [JetKVM - Hardware KVM with suppport for netboot.xyz](https://jetkvm.com/) - [Quickemu](https://github.com/quickemu-project/quickemu) - [Tinkerbell](https://tinkerbell.org/examples/netboot-xyz/) - [u-root](https://github.com/u-root/u-root/blob/main/cmds/exp/netbootxyz/netbootxyz.go) diff --git a/docs/docker.md b/docs/docker.md deleted file mode 100644 index 9b304968..00000000 --- a/docs/docker.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: docker -title: Docker Container -description: "How to use the netboot.xyz docker container" -hide_table_of_contents: true ---- - -```mdx-code-block -import Docker, {toc as DockerTOC} from "@site/external/docker.md" - - - -export const toc = DockerTOC; - -``` diff --git a/docs/docker/_category_.yml b/docs/docker/_category_.yml new file mode 100644 index 00000000..6fab62c9 --- /dev/null +++ b/docs/docker/_category_.yml @@ -0,0 +1,6 @@ +label: Docker Container +position: 4 +collapsed: false +link: + type: generated-index + title: Docker Container diff --git a/docs/docker/dhcp.md b/docs/docker/dhcp.md new file mode 100644 index 00000000..33c8a241 --- /dev/null +++ b/docs/docker/dhcp.md @@ -0,0 +1,100 @@ +--- +title: DHCP Configurations +sidebar_position: 4 +description: "Setting up DHCP for the netboot.xyz Docker Container" +hide_table_of_contents: true +--- + +The netboot.xyz Docker image requires the usage of a DHCP server in order to function properly. If you have an existing DHCP server, usually you will need to make some small adjustments to make your DHCP server forward requests to the netboot.xyz container. The main settings in your DHCP or router that you will typically need to set are: + +* `tftp-server` also known as `next-server`, this option tells the client where to look for the boot file +* `boot-file-name`, this option tells the client which boot file to load + +## Examples + +The following are some configuration examples for setting up a DHCP server to get started. The main configuration you will need to change are `SERVER_IP_ADDRESS` so that DHCP can direct the client to the server running the netboot.xyz Docker container. Because the Docker image is hosting a dnsmasq TFTP server, the boot files are pulled from it and then it will attempt to load the iPXE configs directly from the host. You can then modify and adjust them to your needs. See [booting from TFTP](https://netboot.xyz/docs/booting/tftp/) for more information. + +### Setting up dnsmasq + +To install dnsmasq as your DHCP server under Debian and Ubuntu run: + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + ```shell + sudo apt install dnsmasq + ``` + + + ```shell + sudo dnf install dnsmasq + ``` + + + +Set up your configuration file `/etc/dnsmasq.conf` with the following settings: + +:::note +The following steps are examples and may not be the exact steps you need to take for your environment. Make sure to adjust the configuration to your needs. +::: + +```shell +# /etc/dnsmasq.conf + +# Set the DHCP Range and lease time +dhcp-range=192.168.1.100,192.168.1.200,255.255.255.0,12h + +# Set the default gateway +dhcp-option=option:router,192.168.1.1 + +# Set tne DNS servers +dhcp-option=option:dns-server,8.8.8.8,8.8.4.4 + +# Standard PC BIOS +dhcp-match=set:bios,60,PXEClient:Arch:00000 +dhcp-boot=tag:bios,netboot.xyz.kpxe,,SERVER_IP_ADDRESS + +# 64-bit x86 EFI +dhcp-match=set:efi64,60,PXEClient:Arch:00007 +dhcp-boot=tag:efi64,netboot.xyz.efi,,SERVER_IP_ADDRESS + +# 64-bit x86 EFI (obsolete) +dhcp-match=set:efi64-2,60,PXEClient:Arch:00009 +dhcp-boot=tag:efi64-2,netboot.xyz.efi,,SERVER_IP_ADDRESS + +# 64-bit UEFI for arm64 +dhcp-match=set:efi64-3,60,PXEClient:Arch:0000B +dhcp-boot=tag:efi64-3,netboot.xyz-arm64.efi,,SERVER_IP_ADDRESS +``` + +A breakdown of the configuration: + +- `dhcp-range` sets the range of IP addresses and lease times that will be assigned to clients. +- `dhcp-option` sets the default gateway and DNS servers. +- `dhcp-boot` sets the boot file for different architectures, the `SERVER_IP_ADDRESS` should be replaced with the IP address of the host running the Docker container. +- `dhcp-match` sets the match criteria for different architectures. + +Once the dnsmasq configuration is set, you can enable and start the service: + +```shell +sudo systemctl enable dnsmasq +sudo systemctl start dnsmasq +``` + +## netboot.xyz boot file types + +The following bootfile names can be set as the boot file in the DHCP configuration depending on your needs. They are baked into the Docker image: + +| bootfile name | description | +| --------------------------------|----------------------------------------------------------------------| +| `netboot.xyz.kpxe` | Legacy DHCP boot image file, uses built-in iPXE NIC drivers | +| `netboot.xyz-undionly.kpxe` | Legacy DHCP boot image file, use if you have NIC issues | +| `netboot.xyz.efi` | UEFI boot image file, uses built-in UEFI NIC drivers | +| `netboot.xyz-snp.efi` | UEFI w/ Simple Network Protocol, attempts to boot all net devices | +| `netboot.xyz-snponly.efi` | UEFI w/ Simple Network Protocol, only boots from device chained from | +| `netboot.xyz-arm64.efi` | DHCP EFI boot image file, uses built-in iPXE NIC drivers | +| `netboot.xyz-arm64-snp.efi` | UEFI w/ Simple Network Protocol, attempts to boot all net devices | +| `netboot.xyz-arm64-snponly.efi` | UEFI w/ Simple Network Protocol, only boots from device chained from | +| `netboot.xyz-rpi4-snp.efi` | UEFI for Raspberry Pi 4, attempts to boot all net devices | diff --git a/docs/docker/overview.md b/docs/docker/overview.md new file mode 100644 index 00000000..66e381b0 --- /dev/null +++ b/docs/docker/overview.md @@ -0,0 +1,39 @@ +--- +title: Overview +sidebar_position: 1 +description: "Overview of the netboot.xyz docker container" +hide_table_of_contents: true +--- + +The [netboot.xyz Docker image](https://github.com/netbootxyz/docker-netbootxyz) allows you to easily set up a local instance of netboot.xyz. The container is a small helper application written in node.js. It provides a simple web interface for editing menus on the fly, retrieving the latest menu release of netboot.xyz, and enables mirroring the downloadable assets from Github to your location machine for faster booting of assets. + +![netboot.xyz webapp](../../static/img/netboot.xyz-webapp.png) +It is a great tool for developing and testing custom changes to the menus. If you have a machine without an optical drive that cannot boot from USB then having a local netboot server provides a way to install an OS. If you are looking to get started with netboot.xyz and don't want to manage iPXE menus, you should use the boot media instead of setting up a container. + +The container is built upon Alpine Linux and contains several components: + +* netboot.xyz [webapp](https://github.com/netbootxyz/webapp) +* nginx for hosting local assets from the container +* dnsmasq for providing TFTP services +* syslog for providing tftp activity logs + +Services are managed in the container by [supervisord](http://supervisord.org/). + +The container runs under both x86_64 and ARM based architectures. + +## How it Works + +The following diagram details the flow of how netboot.xyz serves content to a client and how it works when the Docker container is used: + +```mermaid +graph TD + A[Client Computer] -->|PXE Boot Request| B{netboot.xyz container?} + B -- Yes --> C[netboot.xyz container] + C -- Local request --> D[Serve netboot.xyz] + C -- Unavailable --> E[boot.netboot.xyz] + B -- No --> E + E -->|Internet Request| F[boot.netboot.xyz] + F --> G[Serve netboot.xyz] + G --> H[Client Boots OS] + D --> H +``` \ No newline at end of file diff --git a/docs/docker/parameters.md b/docs/docker/parameters.md new file mode 100644 index 00000000..0f817f88 --- /dev/null +++ b/docs/docker/parameters.md @@ -0,0 +1,20 @@ +--- +title: Container Parameters +sidebar_position: 3 +description: "Setting up the netboot.xyz Docker Container" +hide_table_of_contents: true +--- + +Container images are configured using parameters passed at runtime. These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. + +| Parameter | Function | +| :-------: | ------- | +| `-p 3000` | Web configuration interface. | +| `-p 69/udp` | TFTP Port. | +| `-p 80` | NGINX server for hosting assets. | +| `-e WEB_APP_PORT=3000` | Specify a different port for the web configuration interface to listen on. | +| `-e NGINX_PORT=80` | Specify a different port for NGINX service to listen on. | +| `-e MENU_VERSION=2.0.84` | Specify a specific version of boot files you want to use from netboot.xyz (unset pulls latest) | +| `-e TFTPD_OPTS='--tftp-single-port'` | Specify arguments for the TFTP server (this example makes TFTP send all data over port 69) | +| `-v /config` | Storage for boot menu files and web application config | +| `-v /assets` | Storage for netboot.xyz bootable assets (live CDs and other files) | \ No newline at end of file diff --git a/docs/docker/usage.md b/docs/docker/usage.md new file mode 100644 index 00000000..448022c4 --- /dev/null +++ b/docs/docker/usage.md @@ -0,0 +1,157 @@ +--- +title: Setting up the Container +sidebar_position: 2 +description: "Setting up the netboot.xyz Docker Container" +hide_table_of_contents: true +--- + +The netboot.xyz Docker image requires an existing DHCP server to be setup and running in order to boot from it. The image does not start a DHCP server service. Please see the DHCP configuration setup near the end of this document for ideas on how to enable your environment to talk to the container. In most cases, you will need to specify the next-server and boot file name in the DHCP configuration. + +### Installing Docker + +If you have not set up Docker on your system, you can follow the instructions below to install it. The following examples are for Debian, Ubuntu, and Red Hat based systems. + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + ```shell + # Add Docker's official GPG key: + sudo apt-get update + sudo apt-get install ca-certificates curl + sudo install -m 0755 -d /etc/apt/keyrings + sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc + sudo chmod a+r /etc/apt/keyrings/docker.asc + + # Add the repository to Apt sources: + echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \ + $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ + sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + sudo apt-get update + sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin + ``` + + + ```bash + # Add Docker's official GPG key: + sudo apt-get update + sudo apt-get install ca-certificates curl + sudo install -m 0755 -d /etc/apt/keyrings + sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc + sudo chmod a+r /etc/apt/keyrings/docker.asc + + # Add the repository to Apt sources: + echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \ + $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \ + sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + sudo apt-get update + sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin + ``` + + + ```bash + # Setup Repository + sudo dnf -y install dnf-plugins-core + sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo + # Install Docker + sudo dnf install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin + # Start the Docker service + sudo systemctl enable --now docker + ``` + + + +:::note +If you are using a different distribution, please refer to the [official Docker documentation](https://docs.docker.com/get-docker/) for installation instructions. +::: + +### Pulling the Docker image + +The netboot.xyz container image is available from the GitHub Container Registry as well as Docker Hub. The image is updated regularly and is the recommended way to get the latest version of the container: + + + + + ```shell + docker pull ghcr.io/netbootxyz/netbootxyz + ``` + + + ```shell + docker pull netbootxyz/netbootxyz + ``` + + + +The following snippets are examples of starting up the container. + +### Starting up the container with the Docker CLI + +```shell +docker run -d \ + --name=netbootxyz \ + -e MENU_VERSION=2.0.84 `# optional` \ + -e NGINX_PORT=80 `# optional` \ + -e WEB_APP_PORT=3000 `# optional` \ + -p 3000:3000 `# sets web configuration interface port, destination should match ${WEB_APP_PORT} variable above.` \ + -p 69:69/udp `# sets tftp port` \ + -p 8080:80 `# optional, destination should match ${NGINX_PORT} variable above.` \ + -v /local/path/to/config:/config `# optional` \ + -v /local/path/to/assets:/assets `# optional` \ + --restart unless-stopped \ + ghcr.io/netbootxyz/netbootxyz +``` + +**To update the image using Docker CLI:** + +```shell +docker pull ghcr.io/netbootxyz/netbootxyz # pull the latest image down +docker stop netbootxyz # stop the existing container +docker rm netbootxyz # remove the image +docker run -d ... # previously ran start command +``` + +Start the container with the same parameters used above. + +:::note +If the same folders are used your settings will remain. If you want to start fresh, you can remove the paths and start over. +::: + +### Starting up the container with Docker Compose + +1. Copy [docker-compose.yml.example](https://github.com/netbootxyz/docker-netbootxyz/blob/master/docker-compose.yml.example) to docker-compose.yml +1. Edit as needed +1. Run `docker compose up -d netbootxyz` to start containers in the background +1. Run `docker compose logs -f netbootxyz` to view logs + +**To update the image using Docker Compose:** + +```shell +docker compose pull netbootxyz # pull the latest image down +docker compose up -d netbootxyz # start containers in the background +``` + +### Accessing the container services + +Once the container is started, the following services will be available via browser: + +| Service | Description | +|-----------------------|-----------------------------| +| http://localhost:3000 | Web configuration interface | +| http://localhost:8080 | Downloaded web assets | + +:::note +If you wish to remove the configuration, you can remove the local configuration folders and upon restart of the container, it will load the default configurations. +::: + +### Local Mirror Access + +If you want to pull the Live Images images down to your own mirror and boot off them you will need to update the `live_endpoint` variable in `local-vars.ipxe` file within the web configuration interface. + +The [local-vars.ipxe](https://github.com/netbootxyz/netboot.xyz/blob/master/roles/netbootxyz/templates/local-vars.ipxe.j2) is a file that is checked early during the boot [process](https://github.com/netbootxyz/netboot.xyz/blob/master/roles/netbootxyz/templates/disks/netboot.xyz.j2#L99) and will load up variables into netboot.xyz. Using this file, you can set overriddes for variables early in the boot process. + +By default the `live_endpoint` variable is set to upstream location of `https://github.com/netbootxyz`. If you want to override this, set `live_endpoint` to your deployment IP or domain, e.g. `http://192.168.0.50:8080`. It will then redirect asset download to the local location you set for assets on port `8080` and you can download the assets by using the local assets menu down to your local server. This can result in much faster boot times. diff --git a/docs/introduction.md b/docs/introduction.md index 9bab685c..edd8a4eb 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,5 +1,6 @@ --- id: introduction +sidebar_position: 1 title: Introduction description: netboot.xyz uses iPXE to network boot Operating System installers and utilities from an easy to use menu." hide_table_of_contents: true diff --git a/docs/kb/_category_.yml b/docs/kb/_category_.yml new file mode 100644 index 00000000..1b918a7e --- /dev/null +++ b/docs/kb/_category_.yml @@ -0,0 +1,5 @@ +label: Knowledge Base +collapsed: true +link: + type: generated-index + title: Knowledge Base diff --git a/docs/kb/hardware/_category_.yml b/docs/kb/hardware/_category_.yml new file mode 100644 index 00000000..fb7a3109 --- /dev/null +++ b/docs/kb/hardware/_category_.yml @@ -0,0 +1,5 @@ +label: Hardware +collapsed: true +link: + type: generated-index + title: Hardware diff --git a/docs/kb/networking/_category_.yml b/docs/kb/networking/_category_.yml new file mode 100644 index 00000000..6858c355 --- /dev/null +++ b/docs/kb/networking/_category_.yml @@ -0,0 +1,5 @@ +label: Networking +collapsed: true +link: + type: generated-index + title: Networking diff --git a/docs/kb/providers/_category_.yml b/docs/kb/providers/_category_.yml new file mode 100644 index 00000000..13e36a55 --- /dev/null +++ b/docs/kb/providers/_category_.yml @@ -0,0 +1,5 @@ +label: Provider Usage +collapsed: true +link: + type: generated-index + title: Provider Usage diff --git a/docs/kb/pxe/_category_.yml b/docs/kb/pxe/_category_.yml new file mode 100644 index 00000000..dd1ec6a7 --- /dev/null +++ b/docs/kb/pxe/_category_.yml @@ -0,0 +1,5 @@ +label: PXE Usage +collapsed: true +link: + type: generated-index + title: PXE Usage diff --git a/docs/quick-start.md b/docs/quick-start.md index cc8eac71..3e64b953 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,13 +1,12 @@ --- id: quick-start +sidebar_position: 2 title: Quick Start description: "Getting started with netboot.xyz" hide_table_of_contents: true --- -### Getting started - -[Download](https://netboot.xyz/downloads/) one of the netboot.xyz bootloaders that works best for your situation and start PXE booting your favorite operating system. The bootloaders are precompiled versions of the latest version of [iPXE](https://github.com/ipxe/ipxe) that will allow you to PXE boot into [https://boot.netboot.xyz](https://boot.netboot.xyz). If you have DHCP it'll automatically attempt to boot from DHCP. If you need to set a static IP address, hit the 'm' key during boot up for the failsafe menu and choose manual network configuration. +[Download](https://netboot.xyz/downloads/) one of the netboot.xyz bootloaders that works best for your situation and start PXE booting your favorite operating system. The bootloaders are precompiled versions of the latest version of [iPXE](https://github.com/ipxe/ipxe) that will allow you to PXE boot into [https://boot.netboot.xyz](https://boot.netboot.xyz). If you have DHCP it'll automatically attempt to boot from DHCP. If you need to set a static IP address, hit the **`m`** key during boot up for the failsafe menu and choose manual network configuration. You can look at the next section entitled [Booting Methods](https://netboot.xyz/docs/category/booting-methods) for instructions on how to set up the downloaded bootloader. diff --git a/docs/selfhosting.md b/docs/selfhosting.md index 203594da..49fcee49 100644 --- a/docs/selfhosting.md +++ b/docs/selfhosting.md @@ -1,6 +1,7 @@ --- id: selfhosting title: Self Hosting +sidebar_position: 4 description: "How to self host your own netboot.xyz in your environment" hide_table_of_contents: true --- diff --git a/docusaurus.config.js b/docusaurus.config.js index 94e86f53..bb1b7600 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -11,6 +11,10 @@ module.exports = { favicon: "img/favicon.ico", organizationName: "netbootxyz", projectName: "netboot.xyz", + markdown: { + mermaid: true, + }, + themes: ['@docusaurus/theme-mermaid'], themeConfig: { metadata: [{name: 'keywords', content: 'ipxe, netbootxyz, pxe, linux, os, operating system, install, installer, netboot, netboot.xyz'}], prism: { @@ -23,6 +27,9 @@ module.exports = { }, docsSideNavCollapsible: true, image: 'img/nbxyz_logo_name.png', + mermaid: { + theme: {light: 'neutral', dark: 'dark'}, + }, announcementBar: { id: "announcementBar-1", // Increment on change content: `If you like netboot.xyz, give it a star on GitHub⭐️, follow us on Twitter ${TwitterSvg} and join our Discord!`, diff --git a/package.json b/package.json index 528a3894..5fc8f507 100644 --- a/package.json +++ b/package.json @@ -14,6 +14,7 @@ "dependencies": { "@docusaurus/core": "3.7.0", "@docusaurus/preset-classic": "3.7.0", + "@docusaurus/theme-mermaid": "3.7.0", "@docusaurus/theme-search-algolia": "3.7.0", "@mdx-js/react": "3.1.0", "clsx": "2.1.1", diff --git a/sidebars.js b/sidebars.js index e7d2807c..471efb3b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,90 +1,8 @@ -module.exports = { - docs: [ - 'introduction', - { - type: 'category', - label: 'Getting Started', - link: { - type: 'generated-index', +export default { + myAutogeneratedSidebar: [ + { + type: 'autogenerated', + dirName: '.', // '.' means the current docs folder }, - collapsed: false, - items: [ - 'quick-start', - { - type: 'category', - label: 'Booting Methods', - link: { - type: 'generated-index', - title: 'Booting Methods', - description: 'Select your desired netboot.xyz boot method below:', - }, - items: [ - 'booting/usb', - 'booting/iso', - 'booting/ipxe', - 'booting/grub', - 'booting/qemu', - 'booting/tftp', - 'booting/vmware', - ], - }, - ], - }, - 'docker', - 'selfhosting', - 'faq', - { - type: 'category', - label: 'Community', - link: { - type: 'generated-index', - }, - collapsed: true, - items: [ - 'community/build-automation', - 'community/changelog', - 'community/contributing', - 'community/nbxyz-users', - ], - }, - { - type: 'category', - label: 'Knowledgebase', - link: { - type: 'generated-index', - }, - collapsed: true, - items: [ - { - "Hardware": [ - 'kb/hardware/steamdeck', - ], - }, - { - "Networking": [ - 'kb/networking/asuswrt-merlin', - 'kb/networking/edgerouter', - 'kb/networking/mikrotik', - ], - }, - { - "Provider Usage": [ - 'kb/providers/digitalocean', - 'kb/providers/equinixmetal', - 'kb/providers/gce', - 'kb/providers/linode', - 'kb/providers/oci', - 'kb/providers/openstack', - 'kb/providers/vultr', - ], - }, - { - "PXE Usage": [ - 'kb/pxe/ubuntu', - 'kb/pxe/windows', - ], - }, - ], - }, - ], -}; + ], + }; \ No newline at end of file diff --git a/static/img/netboot.xyz-webapp.png b/static/img/netboot.xyz-webapp.png new file mode 100644 index 00000000..ccf3f2c6 Binary files /dev/null and b/static/img/netboot.xyz-webapp.png differ