Documentation Home

Media Assets

This module supports uploading an archive file (in .zip format) of static assets. This .zip file can include a nested folder
structure and will dynamically assign URLs to the assets based on this folder structure.

Static assets are usually images but they can really be any type of digital resource (like a PDF). The underlying operation that is performed to create the asset in Broadleaf is the same as when uploading the asset individually which means the URL that is generated is the same as the file name.

For instance, given the following zip file structure in a file called myfile.zip:

image1.png
image2.png
some-pdf-document.pdf
a-folder/
    image1-inside-a-folder.png
    image2-inside-a-folder.png

This will create the following Broadleaf Static Assets located at the following URLs:

File Name Attainable URL
image1.png /cmsstatic/image1.png
image2.png /cmsstatic/image2.png
some-pdf-document.pdf /cmsstatic/some-pdf-document.pdf
image1-inside-a-folder.png /cmsstatic/a-folder/image1-inside-a-folder.png
image2-inside-a-folder.png /cmsstatic/a-folder/image2-inside-a-folder.png

In version 2.0.0-GA and above, the asset import will also create folders (starting at the root) for assets. In the above
example, image1.png, image2.png and some-pdf-document.pdf would all go in the Root folder, while image1-inside-a-folder.png
and image2-inside-a-folder.png would both go in the newly-created a-folder. If a folder already exists in the hierarchy
by that name it is not created again.

For additional configuration options for these assets like where the uploads should be saved or resizing options after upload, refer to the general Broadleaf documentation on the asset server.