https://github.com/greg-1-anderson/core-vendor-hardening

Test core-vendor-hardening patch
https://github.com/greg-1-anderson/core-vendor-hardening

Last synced: 21 days ago
JSON representation

Test core-vendor-hardening patch

• Host: GitHub
• URL: https://github.com/greg-1-anderson/core-vendor-hardening
• Owner: greg-1-anderson
• License: gpl-2.0
• Created: 2019-08-07T15:32:18.000Z (over 5 years ago)
• Default Branch: 8.8.x
• Last Pushed: 2019-09-16T03:32:30.000Z (over 5 years ago)
• Last Synced: 2024-10-26T06:51:21.296Z (2 months ago)
• Language: PHP
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
The Drupal Vendor Hardening Composer Plugin

===========================================

Thanks for using this Drupal component.

You can participate in its development on Drupal.org, through our issue system:

https://www.drupal.org/project/issues/drupal

You can get the full Drupal repo here:

https://www.drupal.org/project/drupal/git-instructions

You can browse the full Drupal repo here:

http://cgit.drupalcode.org/drupal

What does it do?

----------------

This Composer plugin does two things:

1) It removes extraneous directories from the project's vendor directory.

They're typically directories which might contain executable files, such as test

directories.

This sort of processing is required for projects that have a vendor directory

inside the HTTP server docroot. This is a common layout for Drupal.

By default, the plugin knows how to clean up packages for Drupal core, so you

can require drupal/core-vendor-hardening in your project and the rest will

happen automatically.

The plugin can also be configured to clean up additional packages using the

project's composer.json extra field.

2) The plugin also adds .htaccess and web.config files to the root of the

project's vendor directory. These files will do due diligence to keep the web

server from serving files from within the vendor directory.

How do I set it up?

-------------------

Require this Composer plugin into your project:

    composer require drupal/core-vendor-hardening

When you install or update, this plugin will look through each package and

remove directories it knows about.

You can see the list of default package cleanups for this plugin in Config.php.

If you discover that this list needs updating, please file an issue about it:

https://www.drupal.org/project/issues/drupal

In addition to the default list of packages, you can configure the plugin using

the root package's composer.json extra field, like this:

    "extra": {

      "drupal-core-vendor-hardening": {

        "vendor/package": ["test", "documentation"]

      }

    }

The above code will tell the plugin to remove the test/ and documentation/

directories from the 'vendor/package' package when it is installed or updated.