Skip to content
Documentation

Plugins

Neleto offers a versatile plugin system, allowing you to extend your site's functionality to fit your needs.

Plugins in Neleto can provide a wide range of additional functionalities, like:

  • Providing new Components
  • Rewriting pages with custom logic to include new functionality
  • Adding dashboard-widgets
  • Themeing your website
  • Providing files like icons/images or scripts
  • API Endpoints

Installing a Plugin

There are two straightforward methods for installing a plugin in your Neleto instance:

Uploading a .tar.gz File

If you have a .tar.gz file of your plugin, simply navigate to the Plugins menu and click on the Upload Plugin button located in the upper right corner. Then select the .tar.gz file. Once the upload is complete and the plugin is installed, the plugin should appear in your list of installed plugins. This way the plugin will only be available to users of your Neleto instance.

Through the Plugin Store

The Plugin Store lets you install published plugins straight from your instance, no download or upload step needed. Open the Plugins page and click the Store button in the upper right corner to browse what's available.

This includes the plugins Neleto publishes itself, such as Site Search, Blog Comments, Google Reviews, Site Health and Media Gallery (see the five built-in plugins). Click a plugin to install it; it then appears in your list of installed plugins just like an uploaded one.

When a newer version of an installed store plugin is available, you can update it with a single click. Use the Info button on a plugin for more details, including the option to pick a specific version to install.

Plugins you build yourself can be published to the store with the Plugin CLI, or installed privately on a single instance with the .tar.gz upload above.

Managing Plugins

On the Plugins page, you can manage installed plugins and their data and functions. If you click on the Settings button for a specific plugin, you can see which pages a plugin adds to your website and, if necessary, set a layout for these pages. Clicking on the name of the plugin or on Plugin-UI will take you to the plugin UI. Here you can manage the plugin's data and functions. This UI is defined by the plugin itself, so it will vary depending on the plugin.

Under Logs you can see the plugin's log entries. These can help you if a plugin is not working correctly.