Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated guide on how to opt into geoip #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/provisioner/geoip/geoip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Binary file added doc/provisioner/geoip/images/device_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/provisioner/geoip/images/enable_geoip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/provisioner/geoip/images/regen_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.