eea.api.controlpanel 1.0

Controlpanel RestAPI additional endpoints to be used with Volto @eeacms/volto-controlpanel

The eea.api.controlpanel is a Plone add-on to be used together with volto-controlpanel Volto add-on

Contents

• Main features

• Environment variables

• Install

• Develop

• Source code

• Eggs repository

• Plone versions

• How to contribute

• Copyright and license

• Funding

• Changelog

Main features

1. Easy to install/uninstall via Site Setup > Add-ons

2. RestAPI for controlpanel versions details

Environment variables

• BACKEND_VERSION - Backend version to be saved to registry when Plone instance starts. You should update this environment variable every time you deploy a new version of your backend.

Install

• Add eea.api.controlpanel to your eggs section in your buildout and re-run buildout:

  [buildout]
  eggs +=
    eea.api.controlpanel

• Or via docker:

  $ docker compose up plone6

• Or via pip:

  $ pip install eea.api.controlpanel

• Install eea.api.controlpanel within Site Setup > Add-ons

Develop

$ git clone https://github.com/eea/eea.api.controlpanel.git
$ cd eea.api.controlpanel
$ git checkout develop
$ make help

Source code

• Github

Eggs repository

• https://pypi.python.org/pypi/eea.api.controlpanel

• http://eggrepo.eea.europa.eu/simple

Plone versions

It has been developed and tested for Plone 5 and 6. It should work on any Plone version that supports Volto.

How to contribute

See the contribution guidelines (CONTRIBUTING.md).

Copyright and license

eea.api.controlpanel (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

The Initial Owner of the Original Code is European Environment Agency (EEA). Portions created by Eau de Web are Copyright (C) 2009 by European Environment Agency. All Rights Reserved.

Funding

EEA - European Environment Agency (EU)

Changelog

1.0 - (2024-03-15)

• Moved Version RestAPI endpoint and init logic from eea.kitkat [avoinea - refs #264531]