diff --git a/docs/docs/setup.mdx b/docs/docs/setup.mdx index c49abb4..c38a285 100644 --- a/docs/docs/setup.mdx +++ b/docs/docs/setup.mdx @@ -21,15 +21,18 @@ Options: -h, --help ๐Ÿ™ Show this help message Commands: - build-ui ๐Ÿฆ‹ Create a new UI build - secret ๐Ÿ”’ Generate agent secret - setup ๐Ÿงฐ Run the setup wizard - start ๐Ÿš€ Start web server + build-ui ๐Ÿฆ‹ Create a new UI build + clear-cache ๐Ÿงผ Clear the Redis cache + secret ๐Ÿ”’ Generate agent secret + setup ๐Ÿงฐ Run the setup wizard + start ๐Ÿš€ Start web server ``` ## Setup Wizard -To start the setup wizard, run `hyperglass setup` and you'll receive the following prompts: +To start the setup wizard, run `hyperglass setup`. + +You'll receive the following prompts: ### Installation Directory @@ -41,14 +44,6 @@ To start the setup wizard, run `hyperglass setup` and you'll receive the followi 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`. -### Configuration files - -```shell-session -Do you want to install example configuration files? (This is non-destructive) [y/N]: -``` - -hyperglass can install example configuration files to your hyperglass installation directory to make it a little easier to get up and running. - ### Systemd Service ```shell-session @@ -60,3 +55,28 @@ hyperglass also includes a [systemd](https://systemd.io/) service file, which ca ```shell-session $ sudo systemctl enable hyperglass ``` + +## 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. + +:::note +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. +::: + +```shell-session +$ hyperglass build-ui +โœ… Completed UI build in development mode +``` + +## Startup + +To start hyperglass at the console run `hyperglass start`. + +:::important +hyperglass won't start without a `devices.yaml` file. See the [Adding Devices](adding-devices.mdx) section for instructions on how add devices. +::: + +```shell-session +$ hyperglass start +``` diff --git a/hyperglass/cli/commands.py b/hyperglass/cli/commands.py index 214bde0..834fc29 100644 --- a/hyperglass/cli/commands.py +++ b/hyperglass/cli/commands.py @@ -170,7 +170,6 @@ def setup(unattended): # Project from hyperglass.cli.util import ( create_dir, - move_files, make_systemd, write_to_file, install_systemd, @@ -208,18 +207,6 @@ def setup(unattended): migrate_static_assets(install_path) - example_dir = WORKING_DIR.parent / "examples" - files = example_dir.iterdir() - - do_move = True - if not unattended and not confirm( - "Do you want to install example configuration files? (This is non-destructive)" - ): - do_move = False - - if do_move: - move_files(example_dir, install_path, files) - if install_path == user_path: user = getuser() else: