diff --git a/doc/provisioner/geoip/geoip.md b/doc/provisioner/geoip/geoip.md index ca51af1..38ad222 100644 --- a/doc/provisioner/geoip/geoip.md +++ b/doc/provisioner/geoip/geoip.md @@ -12,7 +12,15 @@ The following are descriptions of terms used in this guide: | Initial Provisioning Phase | This is the first phase of auto-provisioning that happens with a brand new device or factory reset device. This was introduced with the [Security Update](../security/security.md). | ## What does it do? -The GeoIP feature of Provisioner was built to select the closest outbound proxy to the phone when it is initially provisioned and using the global default proxy settings. This way system administrators do not need to manually change the outbound proxy settings for each phone. However, setting the proxies at the Provider or Account level will disable this feature. +The GeoIP feature of Provisioner was built to select the closest outbound proxy to the phone when it is initially provisioned and using the global default proxy settings. This way system administrators do not need to manually change the outbound proxy settings for each phone. This feature is opt-in, so by default it is disabled. + +## Opting in at the Reseller or Account Level +To opt in, you simply need to go into Advanced Provisioner for the account and open up either Provider Settings or Account Settings (the former sets up for a Reseller account propogating to all child accounts while the latter only sets for one end user account). At the bottom of the `Lines` settings page in the `SIP` section, there is a dropdown titled `Use Geoip`. Set it to `Enabled` and save. +![Enabling GeoIP](images/enable_geoip.png) +A window will pop up to ask if you would like to regenerate all the configuration files. +![Regenerating Config files](images/regen_config.png) +Selecting the green Yes button will regenerate all the configuration files so if there are a lot of devices it would take a while to finish. After saving, `Use GeoIP` will now show up in the device settings as `Inherits Enabled from the Provider` or `Inherits Enabled from the Account` depending on which level you setup GeoIP on. +![Device settings showing GeoIP enabled](images/device_settings.png) ## How does it work? During the initial provisioning phase, if the provisioning script detects that the proxy settings are inheriting only from Global Defaults, it will do a geolocation lookup using the public IP of the phone at that moment. Then, based on the geolocation, calculates the closest outbound proxy of the cluster. For our Hosted Platform, it would use our cluster settings. diff --git a/doc/provisioner/geoip/images/device_settings.png b/doc/provisioner/geoip/images/device_settings.png new file mode 100644 index 0000000..1788b52 Binary files /dev/null and b/doc/provisioner/geoip/images/device_settings.png differ diff --git a/doc/provisioner/geoip/images/enable_geoip.png b/doc/provisioner/geoip/images/enable_geoip.png new file mode 100644 index 0000000..a9500f7 Binary files /dev/null and b/doc/provisioner/geoip/images/enable_geoip.png differ diff --git a/doc/provisioner/geoip/images/regen_config.png b/doc/provisioner/geoip/images/regen_config.png new file mode 100644 index 0000000..4426655 Binary files /dev/null and b/doc/provisioner/geoip/images/regen_config.png differ