https://github.com/offline-gmbh/oc-cors-plugin

Setup and manage Cross-Origin Resource Sharing headers in October CMS
https://github.com/offline-gmbh/oc-cors-plugin

cors-plugin octobercms octobercms-plugin

Last synced: 9 months ago
JSON representation

Setup and manage Cross-Origin Resource Sharing headers in October CMS

• Host: GitHub
• URL: https://github.com/offline-gmbh/oc-cors-plugin
• Owner: OFFLINE-GmbH
• License: mit
• Created: 2016-12-23T14:02:01.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2024-01-05T09:59:37.000Z (over 2 years ago)
• Last Synced: 2025-05-31T10:26:25.998Z (about 1 year ago)
• Topics: cors-plugin, octobercms, octobercms-plugin
• Language: PHP
• Size: 29.3 KB
• Stars: 12
• Watchers: 2
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CORS plugin for October CMS

This plugin is based on [https://github.com/barryvdh/laravel-cors](https://github.com/barryvdh/laravel-cors/blob/master/config/cors.php).

All configuration for the plugin can be done via the backend settings.

The following cors headers are supported:

* Access-Control-Allow-Origin

* Access-Control-Allow-Headers

* Access-Control-Allow-Methods

* Access-Control-Allow-Credentials

* Access-Control-Expose-Headers

* Access-Control-Max-Age

Currently these headers are sent for every request. There is no per-route configuration possible at this time.

## Setup

After installing the plugin visit the CORS settings page in your October CMS backend settings.

You can add `*` as an entry to `Allowed origins`, `Allowed headers` and `Allowed methods` to allow any kind of CORS request from everywhere.

It is advised to be more explicit about these settings. You can add values for each header via the repeater fields.

> It is important to set these intial settings once for the plugin to work as excpected!

### Filesystem configuration

As an alternative to the backend settings you can create a `config/config.php` file in the plugins root directory to configure it.

The filesystem configuration will overwrite any defined backend setting.

```php

 true,

    'maxAge'                      => 3600,

    'allowedOrigins'              => ['*'],

    'allowedHeaders'              => ['*'],

    'allowedMethods'              => ['GET', 'POST'],

    'exposedHeaders'              => [''],

    'preflightResponseStatusCode' => 204,

];

```