System configuration


The GeoNetwork’s configuration is made up of a set of parameters that can be changed to accommodate any installation need. These parameters are subdivided into 2 groups:

  • parameters that can be easily changed through a web interface.
  • parameters not accessible from a web interface and that must be changed when the system is not running.

The first group of parameters can be queried or changed through 2 services: xml.config.get and xml.config.update. The second group of parameters can be changed using the GAST tool.


This service returns the system configuration’s parameters.


No parameters are needed.


The response is an XML tree similar to the system hierarchy into the settings structure. The response has the following elements:

  • site: A container for site information.
    • name: Site’s name.
    • organisation: Site’s organisation name.
  • server: A container for server information.
    • host: Name of the host from which the site is reached.
    • port: Port number of the previous host.
  • Intranet: Information about the Intranet of the organisation.
    • network: IP address that specifies the network.
    • netmask: netmask of the network.
  • z3950: Configuration about Z39.50 protocol.
    • enable: true means that the server component is running.
    • port: Port number to use to listen for incoming Z39.50 requests.
  • proxy: Proxy configuration
    • use: true means that the proxy is used when connecting to external nodes.
    • host: Proxy’s server host.
    • port: Proxy’s server port.
    • username: Proxy’s credentials.
    • password: Proxy’s credentials.
  • feedback: A container for feedback information
    • email: Administrator’s email address
    • mailServer: Email server to use to send feedback
      • host: Email’s host address
      • port: Email’s port to use in host address
  • removedMetadata: A container for removed metadata information
    • dir: Folder used to store removed metadata in MEF format
  • ldap: A container for LDAP parameters
    • use:
    • host:
    • port:
    • defaultProfile:
    • login:
      • userDN:
      • password:
    • distinguishedNames:
      • base:
      • users:
    • userAttribs:
      • name:
      • password:
      • profile:

Example of xml.config.get response:

        <host />
        <port />
            <password />


This service is used to update the system’s information and so it is restricted to administrators.


The request format must have the same structure returned by the xml.config.get service and can contain only elements that the caller wants to be updated. If an element is not included, it will not be updated. However, when included some elements require mandatory information (i.e. the value cannot be empty). Please, refer to table_config_parameters.

Mandatory and optional parameters for the xml.config.update service:

Parameter Type Mandatory
site/name string yes
site/organization string no
server/host string yes
server/port integer no
intranet/network string yes
intranet/netmask string yes
z3950/enable boolean yes
z3950/port integer no
proxy/use boolean yes
proxy/host string no
proxy/port integer no
proxy/username string no
proxy/password string no
feedback/email string no
feedback/mailServer/host string no
feedback/mailServer/port integer no
removedMetadata/dir string yes
ldap/use boolean yes
ldap/host string no
ldap/port integer no
ldap/defaultProfile string yes
ldap/login/userDN string yes
ldap/login/password string no
ldap/distinguishedNames/base string yes
ldap/distinguishedNames/users string yes
ldap/userAttribs/name string yes
ldap/userAttribs/password string yes
ldap/userAttribs/profile string no


On success, the service returns a response element with the OK text. Example:


Otherwise a proper error element is returned.