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: about 1 month 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 (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T15:12:49.000Z (about 1 year ago)
- Last Synced: 2025-03-23T12:15:44.316Z (about 1 year ago)
- Topics: builtin-cors-proxy, volto-addon, volto-corsproxy
- Language: JavaScript
- Homepage:
- Size: 131 KB
- Stars: 3
- Watchers: 39
- 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. (Add-ons)
README
# volto-corsproxy
[](https://github.com/eea/volto-corsproxy/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy&branch=develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-corsproxy&branch=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
`make start` now defaults to Volto 18. To run the same setup against Volto 17, use:
VOLTO_VERSION=17 make
VOLTO_VERSION=17 make start
### 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
"dependencies": {
"@eeacms/volto-corsproxy": "*"
}
```
and `volto.config.js`:
```JavaScript
const addons = ['@eeacms/volto-corsproxy'];
```
* If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
```
uvx cookieplone project
cd project-title
```
1. Install or update dependencies, then start the project:
```
make install
```
For a Cookieplone project, start the backend and frontend in separate terminals:
```
make backend-start
make frontend-start
```
For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
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)