S3 Media Ingester

Adds a media ingester for files stored on Amazon S3 compatible object storage.

The complete documentation of S3 Media Ingester can be found at https://biblibre.github.io/omeka-s-module-S3MediaIngester/

Installation

See general end user documentation for Installing a module

Configuration

In Omeka's config/local.config.php, add a section like this:

<?php

return [
    /* ... */
    's3_media_ingester' => [
        'sources' => [
            'my-s3-source' => [
                'label' => 'My S3 source',
                'key' => '<key>',
                'secret' => '<secret>',
                'region' => '<region>',
                'endpoint' => '<endpoint>',
                'bucket' => '<bucket>',
            ],
        ],
    ],
];

In the module global settings (Admin > Modules > S3MediaIngester's "Configure" button) you can choose the default action on original files (keep or delete). This default action can be overriden when importing new media.

Compatibility with other modules

• S3 Media Ingester can be used as a media source for CSVImport

How to use in PHP code

You can use this ingester in PHP code like this

$itemData['o:media'][] = [
    // The ingester name is "s3-" followed by the name of the source configured earlier.
    'o:ingester' => 's3-my-s3-source',
    'ingest_filename' => 'path/to/file.png',
    'original_file_action' => 'keep', // or 'delete'
];
$api->create('items', $itemData);