diff --git a/OPENWIFI.md b/OPENWIFI.md new file mode 100644 index 0000000..4fe4b78 --- /dev/null +++ b/OPENWIFI.md @@ -0,0 +1,37 @@ +# OpenWiFi integration flags + +## Default Device Configuration from provisioning +In order to enable the GW to provide default configurations from the provisioning service, +the GW must have the following configuration: + +``` +autoprovisioning.process = prov,default +``` +This will tell the GW to ask provisioning for the configuration file. If no file exists, it will use the default configuration file. +``` +autoprovisioning.process = default +``` +This will tell the GW to only use default file configurations. This is the default. + +## Automatic Firmware Management +### FMS configuration +In order to have FMS update devices automatically or follow the update policy, the following must be set +in the FMS configuration file. +``` +autoupdater.enabled = true +``` +The default value is `false` +### Provisioning configuration +The default settings can be set in the Provisioning service configuration: +``` +firmware.updater.upgrade = false +firmware.updater.releaseonly = false +``` +#### firmware.updater.upgrade +This selects whether upgrades are allowed by default or not. The default is `false`. +#### firmware.updater.releaseonly +The selects whether upgrades should consider all released firmware or just firmware marked as release. The default is `false`. +### Firmware upgrade rules +Th default rules are only used when no rules are set at the entity, venue, or device level. These settings always supresede aany default values. + + diff --git a/README.md b/README.md index 251cd3d..603ea8d 100644 --- a/README.md +++ b/README.md @@ -46,39 +46,24 @@ You may modify the following fields in the POST - You may include an array of devices UUIDs - Topology and design cannot be set -### Modification rules - - - -## Management policy - -```json -{ - "default" : [], - "acls" : [ - { - "roles" : [ uuid1, uuid2, uuid3 ], - "access" : [ READ, WRITE, ... ] - } , - { - "roles" : [ ... ], - "access" : [ ... ] - } - ] -} +## Geocoding +To support geocoding help, you need to configuration the following in the configuration file. Geocoding is used +when creating location and when reporting analytics. +``` +geocodeapi = google +google.apikey = ********************************** ``` +Currently, only google Geocoding is supported. Additional methods may be added in the future. -## Management roles -Management roles can be created using UUIDs from the SEC service. SEC service may ask prov if deleting a user -is OK. PROV should answer with username in use or something like this. - -Management roles are created by adding UUIDs into a group. Then that UUID may be used in any management -policy. - -Management roles must have a quick way to evaluate all the roles a user has. This is important for -speed. Roles ddo not use subscribers. - -So read all the roles, cross ref all the users sp you can apply access rules against a resource very quickly. - -If a user is part of 2 roles, then the access will be agregate. if NONE is found, then NONE wins. +## Default firmware management rules +FMS is already integrated with OpenWifi. In order to allow it to upgrade devices automatically, you should +set the following values. +``` +firmware.updater.upgrade = +firmware.updater.releaseonly = +``` +### firmware.updater.upgrade +Should FMS attempt to upgrade devices by default. +### firmware.updater.releaseonly +Should only RC software be used during upgrades. \ No newline at end of file