.. _gridconfiguration: Grid configuration ================== In some cases, the configuration properties will not suffice to fully configure your server. In that case, it may be necessary to make use of IceGrid's XML configuration files. Like the :file:`config.xml` file mentioned above, these are stored under :file:`etc/grid`: :file:`etc/grid/default.xml` is used on Unix systems, :file:`etc/grid/windefault.xml` is used on Windows systems and both make use of :file:`etc/grid/templates.xml`. The default OMERO application descriptor deploys multiple server instances (Blitz-0, FileServer, Indexer-0, PixelData-0, ...) on a single node. Each server instance is defined by a ``server-template`` element in :file:`etc/grid/templates.xml` with its own parameters. Modifying the application descriptors ------------------------------------- When you run :omerocmd:`admin start` without any other arguments, it looks up the default **application descriptor** for your platform: :: $ bin/omero admin start No descriptor given. Using etc/grid/default.xml Waiting on startup. Use CTRL-C to exit The "start" and "deploy" command, however, take several other parameters: :: $ bin/omero admin start --help usage: bin/omero admin start [-h] [-u USER] [file] [targets [targets ...]] Start icegridnode daemon and waits for required components to come up, i.e. status == 0 If the first argument can be found as a file, it will be deployed as the application descriptor rather than etc/grid/default.xml. All other arguments will be used as targets to enable optional sections of the descriptor Positional Arguments: file Application descriptor. If not provided, a default will be used targets Targets within the application descriptor which should be activated. If a file is passed in as the first argument, then that **application descriptor** as opposed to :file:`etc/grid/default.xml` will be used. You can also modify the default application descriptors in place. .. note:: The largest issue with using your own application descriptors or modifying the existing ones is that they tend to change between versions, and there is no facility for automatically merging your local changes. You should be prepared to re-make whatever changes you perform directly on the new files. Targets ------- **Targets** are elements within the application descriptors which can optionally turn on configuration. The target is only applicable until the next invocation of :omerocmd:`admin start` or :omerocmd:`admin deploy` .. note:: You must remember to always apply the targets on each :omerocmd:`admin` command. If not, the target will not be removed. Therefore, they are often better used for debugging purposes; however, as opposed to alternative application descriptors, using the pre-existing targets should not require any special effort during upgrades. Debugging ^^^^^^^^^ :: Here, the "debug" target allows increasing the logging output of the Python servers without modifying any files. .. _jmx_configuration: JMX configuration ^^^^^^^^^^^^^^^^^ :: The JMX target activates the monitoring of the Blitz server via JMX. If you need to modify the "jmxport" or "jmxhost" variables, you will need to do so directly in the application descriptor XML. Changing ports / multiple servers on a single host -------------------------------------------------- By modifying the default OMERO ports, it is possible to run multiple OMERO servers on the same physical machine. All port numbers can be adjusted using the relevant :ref:`configuration properties `. To run multiple servers on a single host, the easiest approach is to prefix all ports (SSL, TCP, registry) using :property:`omero.ports.prefix`:: # First server cd ~/OMERO.server-1 bin/omero admin start # Second server cd ~/OMERO.server-2 bin/omero config set omero.ports.prefix 1 bin/omero admin start # Third server cd ~/OMERO.server-3 bin/omero config set omero.ports.prefix 2 bin/omero admin start Clients will need to use the appropriate port (4064, 14064 or 24064) to connect to OMERO. .. seealso:: :ref:`security_ssl` Section of the :doc:`/sysadmins/server-security` page. Extending OMERO --------------- Finally, if configuration does not suffice, there are also options for extending OMERO with your own code. These are described on the development site under |ExtendingOmero|.