diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx index 0eb736a..8843b70 100644 --- a/docs/pages/installation.mdx +++ b/docs/pages/installation.mdx @@ -2,6 +2,7 @@ import { Cards } from "nextra/components"; + diff --git a/docs/pages/installation/docker-ghcr.mdx b/docs/pages/installation/docker-ghcr.mdx new file mode 100644 index 0000000..22e65aa --- /dev/null +++ b/docs/pages/installation/docker-ghcr.mdx @@ -0,0 +1,49 @@ +--- +title: Using Docker +description: Installing hyperglass with Docker +--- + +import { Cards, Steps, Callout } from "nextra/components"; +// import { Callout } from "nextra-theme-docs"; + +**Docker is the recommended method for running hyperglass.** + + + +### Install Docker + + + + + +### Download hyperglass + +```shell copy +mkdir /home/hyperglass +cd /home/hyperglass +wget "https://github.com/thatmattlove/hyperglass/blob/main/compose.yaml" +``` + +### Optional: Quickstart + +Do this if you just want to see the hyperglass page working with a fake device. + +```shell copy +mkdir data +wget -O ./data/devices.yaml "https://raw.githubusercontent.com/thatmattlove/hyperglass/refs/heads/main/.samples/sample_devices.yaml" +docker compose up +``` + +Navigate to http://IPADDRESS:8001 + +### Enable auto-restart + +You may want to ensure that Hyperglass stays running even after a reboot. +To do this, you can easily change the "restart" parameter in `compose.yaml` to `always`. + +