Skip to content

Latest commit

 

History

History
135 lines (90 loc) · 4.79 KB

README.md

File metadata and controls

135 lines (90 loc) · 4.79 KB

Amazon S3 (module for Omeka S)

New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.

Amazon S3 is a module for Omeka S that allows to store files via an external storage provider, Amazon S3.

This module is compatible with Archive Repertory, that allows to keep original filenames for the files managed by Omeka, and the Image Server used with IIIF Server.

Installation

See general end user documentation for installing a module.

The module uses an external library AWS SDK, so use the release zip to install it, or use and init the source.

  • From the zip

Download the last release AmazonS3.zip from the list of releases (the master does not contain the dependency), and uncompress it in the modules directory.

  • From the source and for development:

If the module was installed from the source, rename the name of the folder of the module to AmazonS3, and go to the root of the module, and run:

composer install --no-dev

Quick Start

Simply config your credentials in the config page of the module.

If module is active, it will replace default Local store class with S3 Storage.

In some cases, you need to adjust rights in s3: see issue #2.

Cors

To fix Amazon cors issues, see the aws documentation.

TODO

  • Fill and use the config key [file_store][awss3][base_uri].
  • Allow to keep original url of Omeka (proxy via htaccess), to allow to change backend without losing file urls (see stackoverflow.

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Troubleshooting

See online issues on the module issues page on GitLab.

License

This module is published under the CeCILL v2.1 license, compatible with GNU/GPL and approved by FSF and OSI.

This software is governed by the CeCILL license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user’s attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software’s suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.

The fact that you are presently reading this means that you have had knowledge of the CeCILL license and that you accept its terms.

Copyright

  • Copyright Daniel Berthereau, 2019-2023 (see Daniel-KM on GitLab)

This project was supported in part by the University of California Office of the President MRPI funding MR-15-328710.