Skip to main content
Version: 0.10

Quickstart

This walks through the shortest path from a fresh sign-in to a populated inventory. The steps are the ones the console's own getting-started guide tracks, in the same order:

Each step needs a permission in the tenant (for example, adding a sensor needs write access to Sensors). If your role does not cover a step, someone else in your team takes it; see Roles and permissions.

1. Sign in​

Open your Organization's console address and sign in with your email and password:

https://<your-organization>.velumedge.com
note

The address above is the pattern used throughout these docs. Use the address you were given.

If two-factor authentication is required for your account, you are asked to set up an authenticator app on first sign-in: scan the QR code, then enter the six-digit code to confirm. See Account security.

Once signed in, every tenant screen has the tenant in its address:

/t/<tenantId>/dashboard

Use the tenant switcher at the top of the sidebar to move between the tenants you can reach. See Navigation.

2. Create a tenant​

Skip this step if you already have access to a tenant.

A tenant holds one organisation's sensors, integrations, scans and assets, apart from every other tenant. To create one you need the global Tenants management permission (write):

  1. Open System management (the gear icon in the top bar), then Tenants.
  2. Click Create tenant, enter a name and, optionally, a description.
  3. Click Create.

You are made the new tenant's Project Admin, so every following step is yours to take. The tenant starts with the standard fields, page layouts, a system Excel report template and a General dashboard. See Tenants and users.

3. Add a sensor​

Every integration run and every scan happens on a sensor: a collector you run inside your network, which reaches your systems and reports back to the console over outbound HTTPS. A tenant needs at least one before it can collect anything.

  1. Open Settings → Sensors and click Add sensor.

  2. Reveal or copy the deployment token. Either action creates it, and it is valid for 60 minutes.

  3. Copy or download the ready-made docker-compose.yml, which already contains the token and your console's address, and save it in an empty folder on a Linux host with Docker Engine and the Compose plugin.

  4. Start it from that folder:

    sudo docker compose up -d

The sensor enrols on its first start and appears in the sensors list, usually within a minute. See Install a sensor on Linux (Docker) for the full procedure and the other install options, and Sensors for where to place it.

4. Connect an integration​

An integration is a tool you already run, such as an EDR, a directory or a cloud subscription, that the sensor reads assets from.

  1. Open Settings → Integrations and select the Marketplace tab.
  2. Click the card of a tool you run. The Connect dialog opens.
  3. Fill in the address and credentials, and pick the sensor that can reach the tool. Fields marked * are required.
  4. Click Test connection. The sensor checks the address and credentials and reports each check with a tick or a cross.
  5. When the test passes, click Connect.

The integration now appears on the Connected tab. See Integrations for the catalogue and each integration's permissions.

A connected integration collects nothing on its own

Connecting stores the connection and nothing more. Data only arrives when a scan template that uses the integration is run, on demand or on a schedule: the next two steps.

Which integration should I start with?

Start with whichever tool has the broadest coverage of your estate. In most environments that is the EDR, because it is installed on nearly every managed endpoint. Directory and cloud sources are good second additions: they add identities and cloud workloads the EDR does not see.

5. Create a scan template​

A scan template says what to collect from an integration and how to treat what comes back.

  1. Open Scans → Templates and click New template.
  2. Pick the integration the template scans with.
  3. Give the template a name and fill in every field marked *, pressing Next between pages. Each page is one group of the integration's settings; the last page, Rules, is optional. Where a field has a default, it is fine for a first scan.
  4. Click Create template.
Approve the first runs by hand

In the template's actions, setting what happens to a newly discovered asset to To Approve lets you see what a source reports before it creates anything. See Scan templates.

6. Schedule it (optional)​

A schedule runs a template on a timetable, so the inventory stays current without anyone starting it.

  1. Open Scans → Scheduled and click New schedule.
  2. Enter a Schedule name, an optional description, and choose the Scan template.
  3. Set when it Runs (a cron expression).
  4. Leave Enable straight away ticked to start it now. Schedules are created paused, and this box is what enables the new one.

See Schedules.

7. Run a scan​

Open the template under Scans → Templates and click Run now. (A template whose integration works on an uploaded file shows Run with a file instead.)

The run needs a sensor that is enabled and healthy. If none is, the run waits in Queued until one picks it up. A run usually takes a few minutes, and you can follow it stage by stage.

8. Review the scan​

Open Scans → History and click the run, which is at the top. The run page has three tabs:

TabWhat it shows
OverviewThe run's stages (Queued, Collecting, Uploading, Verification, Cleaning, Identification, Validation, Syncing, Finished), timings, the template and integration, and counts
ResultsThe change entries the run produced: assets it adds or updates in the inventory
FindingsThe raw records the sensor collected

A run can stop and wait for you:

  • Needs review: some changes matched more than one asset. Resolve them to let the run finish.
  • Awaiting approval: the changes are resolved and waiting to be approved into the inventory, because the template asks for approval.

Once the run is Completed, its assets are in the lists under Assets. See Reviewing a scan.

Next steps​