Installation and Administration

Adding Custom Templates

Updated: April 9, 2019

Use a Custom Configuration Template to Store Your Customized Configuration Files

The "custom" template folder allows you to add customization such as using multiple databases, configuring services, etc.

  1. Add your own template files in templates/custom directory. You can use either existing or new parameters in these new template files.
  2. From the Admin tab or by manually editing the nuxeo.conf file, set your parameters' values and set nuxeo.templates=custom. You can refer to custom templates directory with a relative path or to your own custom templates directory with an absolute path.
  3. Edit custom/nuxeo.defaults and set nuxeo.template.includes parameter to define the list of existing templates to include (comma separated values); your custom template will be used at last. nuxeo.defaults files from included templates are also read.

In case you need multiple customizations, create multiple directories and reference them in a dedicated nuxeo.conf for each server.

The following properties cannot be configured from a configuration template (in nuxeo.defaults) and must be defined in nuxeo.conf:

  • nuxeo.data.dir
  • nuxeo.log.dir
  • nuxeo.pid.dir
  • nuxeo.tmp.dir
  • nuxeo.mp.dir

Move Your Configuration out of the Server Directory Structure

The "custom" template folder is a sample configuration template that you can use as is but it is recommended to create your own configuration template named as you want and located outside of the Nuxeo server structure, along with your customized nuxeo.conf.

For instance, under Linux, you could setup:

  • Configuration files (custom templates and nuxeo.conf) under /etc/

    /etc/nuxeo/
    ├── nuxeo.conf
    └── some-custom-template
  • Data under /var/lib/. It is common to also place the server itself under /var/lib/. Other common locations for the server are /opt/nuxeo/, ~nuxeo/nuxeo-cap-x.y-tomcat/ ...

    /var/lib/nuxeo/
    ├── data
    └── server (NUXEO_HOME)
        ├── conf
        ├── lib
        ├── nxserver
        ├── packages
        ├── templates
        ├── webapps
        └── work
  • Log files under /var/log/

  • PID files under /var/run/
  • Temporary files under /tmp/

 


Other Documentation About Templates

Configuration Templates Connecting Nuxeo to the Database

 

We'd love to hear your thoughts!

All fields required