# Configuration

The main configuration file is `setup.yaml`, located in the project setup folder, e.g. `ladder99/setups/example`.

Note: YAML stands for "yet another markup language", and is a way of providing structured data to applications in text files. 


## setup.yaml

First note the **adapter** section - this specifies the device drivers to feed to our Agent. 

In this case, we have a **host** driver, which reads some stats of the local/host computer. 

```yaml
# ladder99 adapter reads this section to know what devices to poll/subscribe to.
adapter:
  devices:
    - id: host # must match id in agent.xml
      name: Host # this must match name in agent.cfg and agent.xml
      # sources define the inputs to the cache.
      sources:
        - module: host # module defines inputs and outputs with yaml files
          driver: host # adapter plugin - manages protocol and payload
      # where agent will connect to adapter
      connection:
        host: adapter # must match agent.cfg value
        port: 7890 # must match agent.cfg value
```

Next, note the **relay** section, which tells the relay which agents to query before passing the data on to the database. 

```yaml
# ladder99 relay reads this section to know what agents and devices to read data from.
# warning: don't change the agent aliases (eg Main) as they are used to synch data with db.
relay:
  # retention: 1wk # could specify a top-level retention for all agents here
  agents:
    - alias: Main # this is an arbitrary alias we assign to each agent, used by the db - don't change!
      url: http://agent:5000 # url to the agent
      # ignore: true # can specify this to turn agent recording on/off
      # retention: 2d # could clear all unneeded data at midnight - then vacuum analyze db?
      # without a list of devices here, relay would read all available in agent
      devices:
        - id: host # must match id in agent.xml
          alias: Host # as displayed in grafana - can change. without this, just use device name?
          # ignore: true # can specify this to turn device recording on/off

    - alias: Mazak5701 # assigned agent alias - don't change!
      url: http://mtconnect.mazakcorp.com:5701
      devices:
        - id: d1 # must match id in agent.xml
          alias: MazakMill12345 # used in path expressions - no spaces!
          # ignore: true # set true to hide device in dashboards, pause recording, etc
```

Link to the full setup.yaml for the example setup [here](../../../setups/example/setup.yaml).


## docker-compose.yaml

Another file with configuration settings is `docker-compose.yaml`. This contains extra configuration for Docker - in this case, mostly just telling it to run all services with a profile name of 'base'. 

```yaml
# docker-compose overrides
# overrides and extends the values in ladder99/services/docker-compose.yaml

# see other client repos for ideas for adding information to services.
# typically, would add 'profiles: - base' to each service used.
# that way, we know what is needed, and can start them all with
#   l99 start base

# version must be a string - need 3.8 for profiles
version: '3.8'

services:
  adapter:
    profiles:
      - base

  agent:
    profiles:
      - base

  dozzle:
    profiles:
      - base

  grafana:
    profiles:
      - base

  # meter:
  #   profiles:
  #     - base

  portainer:
    profiles:
      - base

  postgres:
    profiles:
      - base

  pgadmin:
    profiles:
      - base

  relay:
    profiles:
      - base
```

This lets us run `l99 start` or `l99 start base` to run all the base services.

Link to the full file [here](../../../setups/example/services/docker-compose.yaml).