Skip to main content

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

Project description

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

Source code

Eggs repository

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).

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]

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page