Creating Your First Configuration

tip

The easiest way to create your first configuration is to use the Web Interface. This guide covers the equivalent YAML if you prefer to edit the file directly.

1. Copy this minimal configuration:

   # metricshub.yaml
   attributes:
     site: my-datacenter # Where your resources are located
   
   resources:
     my-first-host: # # Change: unique identifier for this resource
       attributes:
         host.name: 192.168.1.100 # # Change: IP address or hostname
         host.type: linux # # Change: win, linux, network, storage, etc.
       protocols:
         ssh: # # Change: protocol to use (see Protocols below)
           username: admin # # Change: your credentials
           password: changeme # # Change: your password
           timeout: 120s

2. Change host.name to your server's IP address or hostname

3. Change host.type to match your system (see Configuring the Host Types)

4. Update the protocols section with the required protocol(s) and credentials (see Protocols and Credentials)

5. Save as metricshub.yaml in C:\ProgramData\MetricsHub\config for Windows, /opt/metricshub/lib/config for Linux

6. Open Tools > YAML Editor in the Web Interface to validate your configuration

7. Restart MetricsHub.