README.md

volto-controlpanel

Volto add-on that enhance Version Overview information in Control Panel:

• Frontend Version
  • When it was updated and from which version
  • Link to Frontend changelog
  • Volto version and the list of all installed Volto add-ons
• Backend Version
  • When it was updated and from which version
  • Link to Backend changelog
  • List of all Python eggs installed on Backend

Requirements

This addon requires a server-side package to be installed.

• eea.api.controlpanel

Features

Environment Variables

You can control the information displayed in Volto Control Panel via the following environment variables:

• RAZZLE_CHANGELOG_PREFIX - Default: https://github.com/eea - Used to compose the links to CHANGELOG
• RAZZLE_CHANGELOG_SUFFIX - Default: releases - Used to compose the links to CHANGELOG
• RAZZLE_FRONTEND_VERSION - Default: <packageJson.version> - Frontend version
• RAZZLE_FRONTEND_NAME - Default: <packageJson.name> - Used to compose the links to CHANGELOG
• RAZZLE_BACKEND_VERSION - Default: '' - Backend version
• RAZZLE_BACKEND_NAME - Default: plone-backend - Used to compose the backend link to CHANGELOG

Getting started

Try volto-controlpanel with Docker

  git clone https://github.com/eea/volto-controlpanel.git
  cd volto-controlpanel
  make
  make start

Go to http://localhost:3000

Add volto-controlpanel to your Volto project

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

   docker compose up backend

2. Start Volto frontend

• If you already have a volto project, just update package.json:

  "addons": [
      "@eeacms/volto-controlpanel"
  ],
  
  "dependencies": {
      "@eeacms/volto-controlpanel": "*"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-controlpanel
  cd my-volto-project
  

1. Install new add-ons and restart Volto:

   yarn
   yarn start
   

2. Go to http://localhost:3000

3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU) Funding

European Environment Agency (EU)