- 05 Sep 2024
- 3 minutes to read
Location settings
- Updated on 05 Sep 2024
- 3 minutes to read
Location settings can be found via Quick-access menu > Localisation > Location settings. You can configure the following location settings for your site.
General location settings
Setting | Description | Notes |
---|---|---|
Default timezone | This is the default time zone for displaying dates, although each user can override this setting in their profile. Cron tasks and other server settings are specified in this time zone. You should change the setting if it shows as Invalid timezone. | - |
Force timezone | You can allow users to individually select their time zone, or force a time zone for everyone. | - |
CSV Import date format | Date format to be used in CSV imports such as user uploads with date custom profile fields, or HR import. The date format should be compatible with the formats defined in the PHP DateTime class. Below are some examples for 21st March 2022:
| - |
Default country | The country entered here will be used by default on new user accounts unless an alternative country has been provided. To force users to choose a country, just leave this unset. | - |
Default city | A city entered here will be the default city when creating new user accounts unless an alternative has been provided. A user's city can be changed from the default if required. | - |
IP address lookup
By default Totara uses the free online NetGeo (The Internet Geographic Database) server to look up the location of IP addresses. Unfortunately this database is not maintained anymore, and may return wildly incorrect data. It is recommended to install a local copy of free GeoLite2 City database from MaxMind.
IP address location is displayed on a simple map or using Google Maps. Please note that you need to have a Google account, and apply for a free Google Maps API key to enable interactive maps.
Setting | Description | Notes |
---|---|---|
GeoLite2 City MaxMind DB | Location of GeoLite2 City binary data file. This file is not part of Totara distribution and must be obtained separately from MaxMind. You can either buy a commercial version or use the free version. You can find details of how to generate a GeoLite2 account and download the file on their website. Once you have the file, extract it into the /home/vagrant/data/txp-16_data/geoip/ directory on your server. | - |
All country codes | This is the list of countries that may be selected in various places, for example in a user's profile. If blank (the default), the list in countries.php in the standard English language pack is used. This is the list from ISO 3166-1. Otherwise, you can specify a comma-separated list of codes, for example GB,FR,ES. If you add new, non-standard codes here, you will need to add them to countries.php in en and your language pack. | - |
Google Maps
If you use Google Maps features within Totara we strongly recommend that you read and agree to the Google Maps Platform Terms of Service and generate a Google Maps API key for use within your site.
You will need to ensure you have set up billing in order to use the Google Maps API.
Setting | Description | Notes |
---|---|---|
Google Maps Javascript API key | Information on obtaining a key can be found at https://developers.google.com/maps/documentation/javascript/get-api-key. Please refer to the Google Maps Platform Terms of Service for permitted use. For help understanding the Terms of Service refer to the Terms of Service FAQs. If you have purchased a Premium Plan then please enter your Client ID into the API key setting. Totara will recognise this as Client ID and treat it as such. Totara currently uses the Google Maps JavaScript API in the following locations:
| - |
| Google Maps addresses return results influenced by your region/country. For example, searches for 'San Francisco' may return different results if sent from a domain within the United States than one sent from Spain. This should be the ISO 3166-1 code for the appropriate region/country. | - |
| If empty, map text will be displayed using the user's browser's language. Set this setting to force all users to see map text in the specified language. Visit https://developers.google.com/maps/faq#languagesupport for a list of supported languages. | - |
Default zoom level | Sets the initial zoom level of the map. Accepted values range from 0 (the whole world) to 21 (individual buildings). The upper limit can vary depending on the map data available at the selected location. | - |
The Totara Academy has a course dedicated to Localisation in Totara. Here you can learn more on how to localise your system, see best practice, and give it a go yourself.