Uploads

Uploads are LumeCMS primitives to configure folders where upload, edit or remove files. It allows to explore these files in the interface and even preview the content.

To define an upload element in LumeCMS you need 2 things:

• The upload name. For example: "Images".
• The storage used to read and write the content.

Use the cms.upload() function to setup an upload folder:

cms.upload("images", "src:images");

In the example above, we have defined the images upload folder, pointing to the images folder in the src storage.

Extra options

For additional options, use an object like this:

cms.upload({
  name: "images",
  description: "Here you can manage all images of your posts",
  store: "src:images",
});

In addition to name, description and store, uploads have the following options:

label

The visible name of this upload option in the menu. If it's not defined, the name value is used.

cms.upload({
  name: "images",
  label: "Posts' images",
  description: "Here you can manage all images of your posts",
  store: "src:images",
});

publicPath

Used if the public path of the image (once the site is built) is not the same as the image in the source folder. For example, if the files are saved in /assets but they are moved to the root folder:

cms.upload({
  name: "images",
  store: "src:images",
  publicPath: "/",
});

With this configuration, the file /assets/favicon.ico will has the public path /favicon.ico.

listed

Set to false to don't list this upload entry in the CMS homepage.

cms.upload({
  name: "images",
  store: "src:images",
  listed: false, // Hide from the main menu.
});