Skip to content

Config options

Matjaž Lipuš edited this page Sep 26, 2016 · 5 revisions

Config options

{
  # basic presence configuration (mandatory)
  "presence": {
    # interval to refresh presence and run provider checks. 
    "interval": 30000, # miliseconds
    # how many consecutive checks device should be present before announcing it present (0 is immediately)
    "addedCount": 0,
    # how many consecutive checks device should be absent before announcing it absent (0 is immediately)
    "removedCount": 3
  },
  # REST API server configuration (if omitted server is not started)
  "server": {
    "port": 3000,
    # log requests to stdout
    "logRequest": false,
    # use JWT token for auth. (optional)
    "jwt": {
      "secret": "secret"
    },
    # When using API directly from other pages, we need to configure CORS headers.
    "allowedOrigins": ["http://homey.local"]
  },
  # device's custom data storage. If omitted custom device data is not available.
  "storage": {
    # Path to data storage. Can be relative or absolute path. When relative data is stored in `data` folder of presence tracker app.
    # File is created/updated only when data is added/changed
    # File should not be modified manually.
    "path": "data.json"
  },
  # whether we want to enable webhooks
  "hooks": [],
  # List of enabled providers
  # We can remove provider by simply removing it from this config.
  "providers": {
    # ARP scan passes config to arpscan npm module
    "arpscan": {
      # custom arp-scan arguments
      "args": ["-l", "-N", "-I", "en0"]
    },
    # ping provider
    "ping": {
      # path to configuration settings needed for ping provider. Can be absolute or relative, same as storage path.
      "path": "provider.ping.json"
    },
    "tcp-connect": {
      # same as ping
      "path": "provider.tcp-connect.json"
    }
  }
}
Clone this wiki locally