netlogix/compressingfilesystemstorage

Flow Package that provides a WritableFileSystemStorage with zlib Compression

dev-main 2024-11-04 08:57 UTC

Requires

• php: ^8.0
• neos/flow: ^8.3 || ^9.0
• neos/utility-files: ^8.3 || ^9.0

Suggests

• ext-bz2: For using bzip2 compression
• ext-zlib: For using zlib compression

MIT

• compression
• storage
• resources
• Neos
• zlib

README

Flow package that provides a WritableFileSystemStorage with zlib compression. This storage takes care of compressing and decompressing data on the fly, so no special handling is required from the application side.

Internally, PHP stream wrappers are used to deal with compression. Please refer to the PHP documentation.

Installation

composer require netlogix/compressingfilesystemstorage

Configuration

A Flow storage has to be configured with the CompressingWritableFileSystemStorage:

Neos:
  Flow:
    resource:
      storages:
        nlxCompressingFileSystemStorage_zlib:
          storage: Netlogix\CompressingFileSystemStorage\CompressingWritableFileSystemStorage
          storageOptions:
            path: '%FLOW_PATH_DATA%Persistent/CompressingWritableFileSystemStorage/'
            # Can be any PHP stream wrapper, see https://www.php.net/manual/en/wrappers.compression.php
            streamWrapper: 'compress.zlib'