mirror/checktheroads-hyperglass
1
0
Fork 0
mirror of https://github.com/checktheroads/hyperglass synced 2024-05-11 05:55:08 +00:00
Code Releases Activity

update docs

Browse Source
This commit is contained in:
checktheroads
2021-01-28 23:04:09 -07:00
parent 042ce35672
commit 5e09fc90c3
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/setup.mdx
View File

@@ -42,24 +42,24 @@ You'll receive the following prompts:
/etc/hyperglass /etc/hyperglass
``` ```
hyperglass requires a directory on your system to store configuration files, the web UI, logos, etc. You may choose between the current user's home directory or `/etc`. hyperglass requires a directory on your system to store configuration files, the web UI, logos, etc. You may choose between the current user's home directory or `/etc` (use the up/down arrow keys).
## UI Build ## UI Build
After running the setup, the `build-ui` command needs to be run for the first time. This command creates the required file structure for the UI, initializes frontend dependencies, and generates favicons. After running the setup, the `build-ui` command needs to be run for the first time. This command creates the required file structure for the UI, initializes frontend dependencies, and generates favicons.
:::note :::caution
If your system's compute resources are too low, the `build-ui` step will likely fail. See the [system requirements](production.mdx) section for more information. If your system's compute resources are too low, the `build-ui` step will likely fail. You can use the `--timeout` flag to increase the default timeout of 180 seconds. You can also set the environment variable `HYPERGLASS_UI_BUILD_TIMEOUT` for the same result. See the [system requirements](production.mdx) section for more information about system resources.
::: :::
```shell-session ```shell-session
$ hyperglass build-ui $ hyperglass build-ui
✅ Completed UI build in development mode ✅ Completed UI build in production mode
``` ```
## Startup ## Startup
To start hyperglass at the console run `hyperglass start`. To start hyperglass from the console run `hyperglass start`.
:::important :::important
hyperglass won't start without a `devices.yaml` file. See the [Adding Devices](adding-devices.mdx) section for instructions on how add devices. hyperglass won't start without a `devices.yaml` file. See the [Adding Devices](adding-devices.mdx) section for instructions on how add devices.