mirrors/thatmattlove-hyperglass
1
0
Fork 1
mirror of https://github.com/thatmattlove/hyperglass.git synced 2026-04-17 21:38:27 +00:00
Code Issues Activity

Updated documentation

Browse source
This commit is contained in:
Luca Dametto 2024-10-27 13:11:31 +01:00
parent ec669b7466
commit fa754c8f06
2 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/pages/installation.mdx
View file

@ -2,6 +2,7 @@ import { Cards } from "nextra/components";
<Cards>
<Cards.Card href="installation/docker" title="Using Docker" />
<Cards.Card href="installation/docker-ghcr" title="Using Docker (GHCR)" />
<Cards.Card href="installation/manual" title="Manual Installation" />
</Cards>

49
docs/pages/installation/docker-ghcr.mdx Normal file
View file

@ -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";
<Callout type="info">**Docker is the recommended method for running hyperglass.**</Callout>
<Steps>
### Install Docker
<Cards>
<Cards.Card
title="Docker Engine Installation Guide"
href="https://docs.docker.com/engine/install/"
target="_blank"
arrow
/>
</Cards>
### 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`.
</Steps>