Configure - nuxeo-sandbox/nuxeo-presales-docker GitHub Wiki
Environment File
The environment file .env is generated for your project. The contents of the file are environment variables that are passed to the containers in the compose stack. When you modify the environment file, make sure to re-create the container(s) impacted. The alias to auto re-build and re-create the containers for Nuxeo is nx new.
| Var | Description | Example Value |
|---|---|---|
APPLICATION_NAME |
Your Studio Project id, used for registration. | nuxeo-solution |
PROJECT_NAME |
Appended to custom image names. | nuxeo-solution |
NUXEO_IMAGE |
The upstream image to use. | docker.packages.nuxeo.com/nuxeo/nuxeo:2023 |
CONNECT_URL |
The URL for Nuxeo Online Services, used for downloading Nuxeo Packages | https://connect.nuxeo.com/nuxeo/site/ |
NUXEO_DEV |
Development mode: hot-reload and other debug functions are enabled when set to true. | true / false |
NUXEO_PORT |
Host port for Nuxeo. Use this port to connect to your instance (default: http://localhost:8080/). | 8080 |
BUILD_PACKAGES |
Space-separated list of Nuxeo Packages that will be installed when building the custom Nuxeo image. | nuxeo-solution-0.0.0-SNAPSHOT nuxeo drive |
NUXEO_PACKAGES |
Space-separated list of Nuxeo Packages that will be installed at startup. | nuxeo-solution-0.0.0-SNAPSHOT nuxeo-drive |
INSTALL_RPM |
Additional RPMs to install within your container. | python3 |
MONGO_VERSION |
Version of MongoDB to use. Must be compatible with your Nuxeo version. | 6.0 |
OPENSEARCH_IMAGE |
Image of OpenSearch to use. Must be compatible with your Nuxeo version. | opensearchproject/opensearch:1.3.11 |
OPENSEARCH_DASHBOARDS_IMAGE |
Image of OpenSearch Dashboards to use. Must be compatible with your Nuxeo version. | opensearchproject/opensearch-dashboards:1.3.11 |
FQDN |
Fully-qualified domain name. | localhost |
STUDIO_USERNAME |
Your Nuxeo Studio username. | [email protected] |
STUDIO_CREDENTIALS |
You NOS token. | N/A |
NUXEO_CLID |
The registration identifier for yout Nuxeo Server instance. This value is auto-generated by the generate_clid.sh script. |
N/A |
Additional environment variables may be documented on the upstream Nuxeo image.
Adding configuration to nuxeo.conf
As part of the project bootstrap process, a conf directory will be created with both core.conf and system.conf. Modify either file as necessary. The original core.conf file will be preserved inside the conf.d directory if you need to reset the contents.
The repository also provides several additional configuration files in the examples directory. The debug.conf file contains the extensions required to enable remote debug access for the Nuxeo platform. Simply copy examples/debug.conf to the conf directory and uncomment the appropriate debug options. Then use the nx new alias to recreate your container and begin debugging.
The mail.conf configuration provides the nuxeo.conf keys required to set up mail.
You may create as many .conf files in the conf folder as you like. They are all appended to the nuxeo.conf file of the Nuxeo Server container. Tip: the files are appended alphanumerically.
Modifying docker-compose.yml
You may also choose to directly modify docker-compose.yml; however, you may have to manually merge upstream changes if you use git pull to update your project repository. We may make minor changes to support additional features and enhancements. Please feel free to submit bugs or feature requests to https://github.com/nuxeo-sandbox/nuxeo-presales-docker/issues
Next: Commands