Deploying HQ

This page describes deploying Lenses HQ via docker.

The HQ docker image can be configured via volume mounts for the configuration file.

The HQ looks for the config.yaml in the current working directory. This is the root directory for Docker.

Running the Docker

terminal

docker run --name lenses-hq \
--network panoptes \
-p 8080:8080 \
-v $(pwd)/config.yaml:/config.yaml\
public.ecr.aws/q8a6e1s5/public-hq:v6.0.0-alpha.16

---

Prerequisites

The main pre-requirements that has to be fulfilled before Lenses HQ container can be started and those are:

• Postgres database

Complete configuration file

In demo purposes and testing the product you can use our community license

license_key_2SFZ0BesCNu6NFv0-EOSIvY22ChSzNWXa5nSds2l4z3y7aBgRPKCVnaeMlS57hHNVboR2kKaQ8Mtv1LFt0MPBBACGhDT5If8PmTraUM5xXLz4MYv

Main configuration file that has to be configured before running docker command is config.yaml.

Sample configuration file is following:

config.yaml

auth:
  administrators:
    - admin
    - [e-mail]
  users:
    - username: admin
      password: some bycrpt password
  saml:
    enabled: false
    baseURL: http://localhost:9991
    entityID: http://localhost:9991
    metadata: |-
    userCreationMode: manual
    groupMembershipMode: manual
    uiRootURL: /
    groupAttributeKey: groups
http:
  address: :9991
  accessControlAllowOrigin:
    - "*"
  accessControlAllowCredentials: false
  secureSessionCookies: true

license:
  key: ""
  acceptEULA: true

agents:
  address: :10000

database:
  connection: "postgres://postgres:postgres@postgres:5432/hq"
logger:
  mode: text
  level: info
metrics:
  prometheusAddress: :9090

More about configuration options you can find on the HQ configuration page.