identify.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. _identify:
  2. Make cluster nodes identifiable from the GUI
  3. ============================================
  4. When running one or more clusters of GeoServer installations it is useful to identify which
  5. cluster (and eventually which node of the cluster) one is working against by just glancing at
  6. the web administration UI.
  7. This is possible by setting one variable, ``GEOSERVER_NODE_OPTS``, with one of the supported
  8. mechanisms:
  9. * as a system variable
  10. * as an environment variable
  11. * as a servlet context parameter
  12. ``GEOSERVER_NODE_OPTS`` is a semicolon separated list of key/value pairs and it can contain the following keys:
  13. * ``id``: the string identifying the node, which in turn can be a static string, or include the following substitution tokens
  14. * ``$host_ip``: the IP address of the node
  15. * ``$host_name``: the hostname of the node
  16. * ``$host_short_name``: the hostname truncated to not include the domain (``foo.local`` becomes ``foo``)
  17. * ``$host_compact_name``: the hostname with all domain parts shortened to their first character (``foo.local`` becomes ``foo.l``)
  18. * ``color``: the label color, as a CSS color
  19. * ``background``: the background color, as a CSS color
  20. Here are some examples:
  21. .. figure:: images/custom_id.png
  22. :align: center
  23. *GEOSERVER_NODE_OPTS="id:test1;background:black;color:white"*
  24. .. figure:: images/host_ip.png
  25. :align: center
  26. *GEOSERVER_NODE_OPTS="id:$host_ip"*
  27. .. figure:: images/host_name.png
  28. :align: center
  29. *GEOSERVER_NODE_OPTS="id:$host_name"*