@eeacms/volto-embed

volto-embed

GDPR-compliant external resource embedding components for Volto.

Right now it does several things:

• it replaces the Map default block with a variant that's data-protected
• it provides a component <PrivacyProtection> which can be used to wrap other components that wrap sensitive content
• it provides a function addPrivacyProtectionToSchema which adds the fields that are required to configure the "data protection" for any component wrapped in <PrivacyProtection>.

See src/Iframe/ViewIframe for details on how to implement.

Getting started

Try volto-embed with Docker

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

Go to http://localhost:3000

Add volto-embed 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-embed"
  ],
  
  "dependencies": {
      "@eeacms/volto-embed": "*"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-embed
  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)