Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 1df71db199
Fetching contributors…

Cannot retrieve contributors at this time

68 lines (42 sloc) 3.129 kb

You can configure Geokit in you environment files

These defaults are used in Geokit::Mappable.distance_to and in acts_as_mappable

config.geokit.default_units = :miles
config.geokit.default_formula = :sphere

This is the timeout value in seconds to be used for calls to the geocoder web services. For no timeout at all, comment out the setting. The timeout unit is in seconds.

config.geokit.geocoders.request_timeout = 3

These settings are used if web service calls must be routed through a proxy. These setting can be nil if not needed, otherwise, addr and port must be filled in at a minimum. If the proxy requires authentication, the username and password can be provided as well.

config.geokit.geocoders.proxy_addr = nil
config.geokit.geocoders.proxy_port = nil
config.geokit.geocoders.proxy_user = nil
config.geokit.geocoders.proxy_pass = nil

This is your yahoo application key for the Yahoo Geocoder.

See http://developer.yahoo.com/faq/index.html#appid and http://developer.yahoo.com/maps/rest/V1/geocode.html

config.geokit.geocoders.yahoo = 'REPLACE_WITH_YOUR_YAHOO_KEY'

This is your Google Maps geocoder key.

See http://www.google.com/apis/maps/signup.html and http://www.google.com/apis/maps/documentation/#Geocoding_Examples

config.geokit.geocoders.google = 'REPLACE_WITH_YOUR_GOOGLE_KEY'

This is your username and password for geocoder.us. To use the free service, the value can be set to nil or false. For usage tied to an account, the value should be set to username:password.

See http://geocoder.us and http://geocoder.us/user/signup

config.geokit.geocoders.geocoder_us = false 

This is your authorization key for geocoder.ca. To use the free service, the value can be set to nil or false. For usage tied to an account, set the value to the key obtained from Geocoder.ca.

See http://geocoder.ca and http://geocoder.ca/?register=1

config.geokit.geocoders.geocoder_ca = false

Add this to use a username with the Geonames geocoder

config.geokitgeocoders.geonames="REPLACE_WITH_YOUR_GEONAMES_USERNAME"

This is the order in which the geocoders are called in a failover scenario. If you only want to use a single geocoder, put a single symbol in the array. Valid symbols are :google, :yahoo, :us, and :ca. Be aware that there are Terms of Use restrictions on how you can use the various geocoders. Make sure you read up on relevant Terms of Use for each geocoder you are going to use.

config.geokit.geocoders.provider_order = [:google,:us]

The IP provider order. Valid symbols are :ip, :geo_plugin. As before, make sure you read up on relevant Terms of Use for each

config.geokitgeocoders.ip_provider_order = [:geo_plugin,:ip]
Jump to Line
Something went wrong with that request. Please try again.