Sign inSign up

hyperglance/sandbox

By hyperglance

Updated 4 months ago

Try out Hyperglance for free with this sandbox container ⚡

Image
Security
Monitoring & observability
0

2.1K

hyperglance/sandbox repository overview

Hyperglance Sandbox

Requirements

To test out hyperglance locally, all you need is docker / docker desktop installed locally.

PLEASE NOTE: The "Run in Docker Desktop" button on this page should not be used as the container requires --privileged mode. Please use the provided command in the next section.

Usage

To run the sandbox:

docker run --name hyperglance-sandbox -d --pull always --restart always --privileged -v hyperglance-data:/var/lib/data -p 443:443 hyperglance/sandbox:latest

To view the startup log, you can run

docker logs hyperglance-sandbox --follow

Once you see the following, the helm chart has been deployed, and the Hyperglance web ui should be available within 5 minutes.

+--------------------------------------------------------------------------------------------------------+
|    Welcome to                                                                                          |
|     _   ___   ______  _____ ____   ____ _        _    _   _  ____ _____                                |
|    | | | \ \ / /  _ \| ____|  _ \ / ___| |      / \  | \ | |/ ___| ____|                               |
|    | |_| |\ V /| |_) |  _| | |_) | |  _| |     / _ \ |  \| | |   |  _|                                 |
|    |  _  | | | |  __/| |___|  _ <| |_| | |___ / ___ \| |\  | |___| |___                                |
|    |_| |_| |_| |_|   |_____|_| \_\\____|_____/_/   \_\_| \_|\____|_____|                               |
|                                                                                                        |
|    ====================                                                                                |
|    Hyperglance Sandbox.                                                                                |
|    ====================                                                                                |
|                                                                                                        |
|    Listening on port 443 (HTTPS).                                                                      |
|                                                                                                        |
|    HOW TO CONNECT                                                                                      |
|        Visit https://localhost in your browser                                                         |
|        Default User: admin                                                                             |
|        Default Password: admin                                                                         |
|                                                                                                        |
|    Please allow up to 5 minutes for the Hyperglance WebUI to become available.                         |
|                                                                                                        |
+--------------------------------------------------------------------------------------------------------+
Configure the cli
Hyperglance starting, entering bash shell

As you are viewing logs, and not within the bash terminal, you can safely use Ctrl+C to exit out of the log stream.

To enter the container:

docker exec -it hyperglance-sandbox bash

Pod status can be viewed by running the following command in the containers terminal:

hg status

Once the status is "Running", visit https://localhost on your host machine. Once the login screen appears, log in with admin:admin

To exit out of the containers protected bash shell, type exit and press enter.

Upgrading Hyperglance Release

To upgrade to the latest version of Hyperglance, enter the sandbox:

docker exec -it hyperglance-sandbox bash

Run the following command to upgrade:

hg upgrade

Container Data

The sandbox uses a named volume to persist your data in the event that the container is stopped and/or removed. This volume is created the first time the container is run.

As long as the named volume hyperglance-data exists, you can continue where you left off by re-running the same initial docker run command shown in the Usage section.

Container Lifecycle

To stop the running container, run the following command:

docker stop hyperglance-sandbox

By default, the container will always restart when the docker daemon starts. This behaviour can be amended by running:

docker update --restart=unless-stopped hyperglance-sandbox

To restart the container from its stopped state, run the following command:

docker start hyperglance-sandbox

Cleanup

To remove the container, run the following command:

docker stop hyperglance-sandbox && docker rm hyperglance-sandbox

This does not remove the attached volume that persists your data. To remove the volume, run the following command:

docker volume rm hyperglance-data

Migrating To Full Deployment

To migrate from the sandbox to a full deployment, you can backup your sandbox to a Kubernetes based deployment of Hyperglance. This process isn't intended for restoring to a docker based deployment.

  1. Create the backup bundle using the following command:
docker exec -it hyperglance-sandbox bash -c 'hg backup create -o /var/lib/data/backup.tgz'
  1. Copy the backup bundle from the container to the host by using the following command:
docker cp hyperglance-sandbox:/var/lib/data/backup.tgz sandbox-backup.tgz
  1. Copy the exported bundle to the full deployment and run the following command:
hg backup restore --backup-path /path/to/backup.tgz --accept

PLEASE NOTE: Your trial license key is not migrated to the new deployment. You will need a commercial license from Hyperglance. Contact [email protected] for more information.

Tag summary

Content type

Image

Digest

sha256:12d3d69e9

Size

298.6 MB

Last updated

4 months ago

docker pull hyperglance/sandbox