Provisioning generator
The purpose of this module is to create an archive with all the active modules of a platform and the related YAML provisioning file. Afterward, this archive can be used to install these modules on another platform or in the same one if needed.
Screenshots
How to install
- In Jahia, go to "Administration → Server settings → System components → Modules"
- Upload the JAR provisioning-generator-X.X.X.jar
- Check that the module is started
FAQ
How to use
Administration UI
Once installed, the module adds a Provisioning Generator entry under Server Administration → System Components.
From this page you can:
- Generate a new provisioning archive. A loading animation is displayed while the archive is being built. Navigating away and coming back to the page will still show the loading state until generation completes.
- Download the generated archive (
provisioning-export.zip) once it is ready. - Delete the archive from the server.
- See the date and time the archive was last generated.
With Karaf commands
provisioning-generator:generate
Generates an archive in the folder JAHIA_HOME/digital-factory-data/content/tmp/.
Example:
provisioning-generator:generate
With the provisioning API
POST /modules/api/provisioning
Content-Type: application/yaml
- karafCommand: "provisioning-generator:generate"
Archive contents
The generated ZIP file contains:
- One JAR file per active module, as stored in the Jahia module management repository.
- A
provisionning.yamlfile listing all bundles withautoStart: true, ready to be replayed via the Jahia provisioning API.
The archive is also stored in JCR at /sites/systemsite/files/provisioning-generator/provisioning-export.zip and is accessible through the administration UI.
MIT License
Copyright (c) 2022 - present Jahia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.