Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-corsproxy

A Volto middleware that provides a CORS proxy
https://github.com/eea/volto-corsproxy

builtin-cors-proxy volto-addon volto-corsproxy

Last synced: 2 months ago
JSON representation

A Volto middleware that provides a CORS proxy

Host: GitHub
URL: https://github.com/eea/volto-corsproxy
Owner: eea
License: mit
Created: 2019-11-25T08:45:36.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-04-22T17:22:37.000Z (9 months ago)
Last Synced: 2024-11-05T00:34:54.901Z (3 months ago)
Topics: builtin-cors-proxy, volto-addon, volto-corsproxy
Language: JavaScript
Homepage:
Size: 125 KB
Stars: 3
Watchers: 37
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-corsproxy - A CORS-proxy integrated with Volto, enables access to third-party API servers. (Addons)

README

        # volto-corsproxy

[![Releases](https://img.shields.io/github/v/release/eea/volto-corsproxy)](https://github.com/eea/volto-corsproxy/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-corsproxy%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-corsproxy%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-corsproxy-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy-develop)

[Volto](https://github.com/plone/volto) add-on

## Features

###

This package enables fetching data from third-party servers through the Volto

HTTP server, this way bypassing any CORS security restrictions imposed by the

browser.

The way it does this is by providing a pass-through CORS proxy server on the

path (configurable) `/cors-proxy` path. For example, any requests made to the

URL `http://localhost:3000/cors-proxy/http://example.com/` will be piped to

the http://example.com website, through the Volto node server.

As you wouldn't want to provide an open proxy, all proxied destinations need to

be configured either via `settings.allowed_cors_destinations` (which takes

a list of hostnames) or an environment variable called

`RAZZLE_ALLOWED_CORS_DESTINATIONS` (where you need to provide a comma-separated

list of hostnames).

For example:

```

settings.allowed_cors_destinations = ['eea.europa.eu', 'plone.org']

```

or:

```

RAZZLE_ALLOWED_CORS_DESTINATIONS=eea.europa.eu,plone.org yarn start

```

As a convenience feature for dealing with third-party API endpoints, there's

a new action available, `getProxiedExternalContent`, somewhat similar to

Volto's `getContent`. Call it like: `getProxiedExternalContent(thirdpartyurl)`

and it will make that async content available in the Redux content reducer, at

`store.content.subrequests[thirdpartyurl]`.

## Getting started

### Try volto-corsproxy with Docker

      git clone https://github.com/eea/volto-corsproxy.git

      cd volto-corsproxy

      make

      make start

Go to http://localhost:3000

### Add volto-corsproxy to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

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

   ```JSON

   "addons": [

       "@eeacms/volto-corsproxy"

   ],

   "dependencies": {

       "@eeacms/volto-corsproxy": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-corsproxy

   cd my-volto-project

   ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-corsproxy/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-corsproxy/blob/master/DEVELOP.md).

## Copyright and license

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

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-corsproxy/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)