See Changes to UI configuration
UI configuration properties
The default values are set in the client-config-default.json file. You can override the default values in the client-config-custom.json file. By default these files are located in the /var/www/html/ui/config folder. New values will be automatically loaded into the UI but users should delete the cache and reload the UI in their browsers.
When customizing client UI with values in the client-config-custom.json file, you must:
- Only add neccessary customizations to avoid inadvertantly overriding future default values
- For each customization add a top level element with a complete set of values because your new configuration will override all previous elements, for example, if the element is a list, add a full list of values
Property _______________________ | Description _______________________ | Example |
|---|---|---|
config.languages | Language definitions for each language file with a set of translated labels. Consists of:
| {"value":"en_US","name":"English","isDefault":true}, |
config.keymaps | For configuring VM keyboards on ESXi hypervisors, users can select a keymap from the pulldown list. See VM general information. Configure keymaps in VMware first and then enter the Vmware keymap value and a name. See VMware Keyboard Map Documentation. The hypervisor's default keyboard map is the US101 keyboard map (US English). To configure a different default keyboard map, set the "RemoteDisplay.vnc.keyMap" property in the Abiquo Configuration Properties for Remote Services and then set the isDefault value to true for that keyboard. Warning: On ESXi for certain locales, when using remote access from a web client, some keystrokes do not translate. See https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2071245 | {"value":"us", "name":"US English", "isDefault":true}, |
config.protocols |
To get an idea of how these protocols look in the UI, see Manage Firewalls | {"value":"Custom protocol", "protocol":"", "port":"-" }, |
config.loadbalancerprotocols | Predfined protocols and preset options for load balancers. Very similar to the Firewall protocols. To get an idea of how these protocols look in the UI, see Manage Load Balancers | {"value":"Custom protocol", "protocol":"", "port":"-" }, |
| config.loadbalanceralgorithms | ROUND_ROBIN","LEAST_CONNECTIONS","SOURCE_IP" | |
| config.loadbalancerroutingrulesprotocols | "TCP","HTTP","HTTPS" | |
| config.loadbalancerhealthcheckprotocols | "PING","TCP","HTTP","HTTPS" | |
| config.loadbalancerhealthcheck.default.interval | Default interval value when creating load balancer healthcheck (in second). Can be empty (no default value). | 15 |
| config.loadbalancerhealthcheck.default.timeout | Default timeout value when creating load balancer healthcheck (in second). Can be empty. Can be empty (no default value). | 20 |
| config.loadbalancerhealthcheck.default.attempts | Default attempts value when creating load balancer healthcheck (value between 0 and 10). Can be empty (no default value). | 2 |
| config.loadbalanceraddressesreuse | Allow users to reuse load balancer addresses | false |
| config.loadbalanceraddressesliteral | Allow users to specify a literal as a load balancer address, for example, a previously created address | false |
| config.loadbalanceraddressestype | Override load balancer addresses type by hypervisor/device. Default value is an empty object(config.loadbalanceraddressestype: {}) To define values for an hypervisor/device, add a new property with the name of the hypervisor/device and set the list of accepted values. Values accepted: ["PRIVATE","PUBLIC","PRIVATE_AND_PUBLIC","NATIP","PRIVATE_AND_NATIP"] | { "nsx-gateway":["PRIVATE","PUBLIC"], |
config.monitoringstatistics | Monitoring statistics can restrict the available metrics | {"value":"average", "name":"Average"}, |
| config.monitoringperiods | {"value":"hours", "name":"Hours"}, | |
egg.speak | Speak error messages with Egg Speak. By default, this experimental feature is not enabled | false |
config.endpoint |
| From Abiquo 4.0, the default is the domain URL e.g. https://myabiquoserver.bcn.abiquo.com/api |
api.version |
| 3.10 |
| client.id |
| "abiquo_client_id" |
| client.license.warning.days.to.expire | 30 | |
client.backto.url |
| |
| client.modalblocker.timeout.milliseconds |
| 800 |
client.themes | See Abiquo Branding Guide and Abiquo Branding Admin Guide | ["abicloudDefault"] |
client.window.title | Browser tab title for Abiquo window | ["Abiquo"] |
| client.google.analytics.id | ||
| client.google.analytics.url | ||
| rdpaccess.usesslproxy | If false, allow insecure HTTP connections to Hyper-V VMs (not recommended). | true |
| client.captcha.publickey | Captcha public key. When users can reset their passwords in Abiquo, you can use ReCaptcha. To enable ReCaptcha for Abiquo, request keys from this link: https://www.google.com/recaptcha/admin#createsite. Set the private key value for abiquo.captcha.private.key in abiquo.properties. See Abiquo Configuration Properties#captcha. See also Configuration View#Password | |
client.external.js.loader.url |
| externaljsloadertemplate.html |
client.google.maps.enabled |
| true |
| client.google.maps.key |
| |
client.password.recovery | If the system property to Allow password reset is false (see Configuration View#Password), set this option to false to hide the "Forgot your password" link. | true |
| client.offline |
| false |
| config.enterprise.properties | ||
| config.enterprise.onlyuseproviders | If true, group clouds by provider when editing tenants to allow provider regions and when creating, editing, and displaying scopes | true |
client.backup |
| |
| client.backup.policies.poweredvmeditable | If true, allow user to edit backup policies in VMs that are powered on | false |
| client.backup.policies.multipleselectionallowed | If true, allow user to select multiple policies for a VM | false |
| client.backup.restore.allowreplicabackuprestore | If true, display Restore link for backups with replication, allowing the user to restore these backups | true |
| client.debug.metrics.create | Development property | false |
client.openid.enabled |
| true |
client.openid.skip.login.view |
| true |
| client.header.link.usersmanagement | URL of external link to open from users management button in main menu. See Add external link in Abiquo header menu | |
| client.footer.about.hide | Hide external About link in footer | false |
| client.footer.support.hide | Hide external Support link in footer | false |
client.virtualmachine.guestinitialpassword.enabled | If true, if the user created a VM and it is deployed, display the key button on the VM control panel. The user can click the key button to display the initial guest password. See Guest setup | true |
| client.wiki.version | Wiki space to use for wiki links to Abiquo documentation, for example, "doc" for current version or "ABI40" after a new version is released | "doc" |
| config.harddiskcustomcontrollertypes | List of controller types to display pull-down list when user adds a virtual disk to a VM. See Display custom list of controllers when adding virtual disk to VM. | |
| config.harddiskcustomcontrollers | List of controllers to display pull-down list when user adds a virtual disk to a VM. See Display custom list of controllers when adding virtual disk to VM. | |
| client.classicfirewalls.enabled | Enable Classic firewalls feature in the UI | false |
Examples of Custom and Default UI configuration
Abiquo client-config-custom.json
Add only your changes to the configuration. If your client endpoint is different to the API endpoint, set the config.endpoint. See #Configure API Endpoint. And for example, set the config.languages to keep the English language and add the Spanish language to your user interface. Abiquo will load the Spanish language file.
{
"config.endpoint": "http://a.differenturl.com/api",
"config.languages":[
{
"value":"en_US",
"name":"English",
"isDefault":true
}
{
"value":"es_ES",
"name":"Spanish",
"isDefault":false
}
]
}
Abiquo 4.4 client-config-default.json
A sample file for Abiquo 4.4 is included here. Note that Abiquo will replace the api.location and api.version variables during the install process.
For example