Where is nuxeo.conf?

See Adding configuration to nuxeo.conf

How do I add a new nuxeo.conf value to the image?

See Adding configuration to nuxeo.conf

How do I update the Nuxeo configuration once I’ve already started the Nuxeo image?

Edit one of the files in ./conf/ and use nx new to refresh the configuration.

What order are configuration files (.conf) appended to nuxeo.conf?

See Adding configuration to nuxeo.conf

How do I add a Nuxeo Package to my image?

Edit your .env file and add the package to NUXEO_PACKAGES or BUILD_PACKAGES. For the former, then run nx new. For the latter, run nx build and then nx new.

How do I get an updated version of Nuxeo (hotfixes, version release)?

You will need to pull the latest Nuxeo image and build our custom image. You can use nx pullbuild to update your image to the latest working version. This command runs the equivalent of nxpull followed by nx build.

How do I add a custom ZIP package to my image?

There are two ways to add a ZIP package. You can add them to the image at build time, or deploy them at runtime.

Option 1: Add at Build Time

Copy the package ZIP file to ${COMPOSE_DIR}/init/ and modify the ${COMPOSE_DIR}/build_nuxeo/Dockerfile to manually add the package with the install-packages.sh script (instructions are included in the Dockerfile). Once added, rebuild your Nuxeo image with nx build and nx start it up.

Option 2: Add at Runtime

Create a directory named “nuxeo_packages” under ${COMPOSE_DIR}. Then add a volume to the nuxeo service in docker-compose.yml that maps the “nuxeo_packages” directory to “/opt/nuxeo/packages” inside the container (example below).

  - "./nuxeo_packages:/opt/nuxeo/packages"

Any ZIP / package that you copy to ${COMPOSE_DIR}/nuxeo_packages will now be available for installation inside the container. Then, edit the environment ${COMPOSE_DIR}/.env (run nxenv) to add your custom ZIP package:

NUXEO_PACKAGES=/opt/nuxeo/packages/mypackage.zip

Finally, run nx new to rebuild your container, which will install the new package.

Where can I find nuxeoctl?

You probably don’t need to use nuxeoctl at all. Make sure you’re updating the ${COMPOSE_DIR}/.env file with the packages you’d like to use. If, in the case you do need to use nuxeoctl, start a shell with Nuxeo: nxbash The command will start a Bash shell inside the Nuxeo container where you can run nuxeoctl commands.

How do I use Nuxeo CLI sync?

As of release 2.0.0 you can run nuxeo sync configure to set up the sync.

For prior versions, you need to map nuxeo.war from the container to a local folder. Edit the docker-compose.yml file and add this line to the volumes section for nuxeo:

      - ./nuxeo_war:/opt/nuxeo/server/nxserver/nuxeo.war:rw

This will mount the local folder nuxeo_war as the nuxeo.war folder in the container. You can then use nuxeo_war in your nuxeo sync command as the --dest folder.

---

Next: I'm having a problem