Metadata

Distro Index Owner:
eea
Home Page:
eea.api.controlpanel
License
GPL version 2
Version:
1.0
Last updated:
2024-03-18
Keywords:
EEA Add-ons Plone Zope

eea.api.controlpanel

Files

Indexes

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

eea.api.controlpanel

Develop Master

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

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

Plone versions

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

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]