Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.82 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.82 KB
Raw

S3 plugin for Redmine/RedMica

Description

This Redmine plugin makes file attachments be stored on Amazon S3 rather than on the local filesystem. This is a fork for original gem and difference is that this one supports RedMica 2.2.2 and later(compatible with Redmine 5.0.5 and later)

Installation

  1. Make sure Redmine is installed and cd into it's root directory
  2. git clone https://github.com/redmica/redmica_s3.git plugins/redmica_s3
  3. cp plugins/redmica_s3/config/s3.yml.example config/s3.yml
  4. Edit config/s3.yml with your favourite editor
  5. bundle install --without development test for installing this plugin dependencies (if you already did it, doing a bundle install again would do no harm)
  6. Restart web server/upload to production/whatever
  7. Optional: Run rake redmica_s3:files_to_s3 to upload files in your files folder to s3

Options Overview

  • The bucket specified in s3.yml will be created automatically when the plugin is loaded (this is generally when the server starts).

Options Detail

  • access_key_id: string key (required)
  • secret_access_key: string key (required)
  • bucket: string bucket name (required)
  • folder: string folder name inside bucket (for example: 'attachments')
  • endpoint: string endpoint instead of s3.amazonaws.com
  • region: string aws region (activate when endpoint is not set)
  • thumb_folder: string folder where attachment thumbnails are stored; defaults to 'tmp'
  • import_folder: string folder where import files are stored temporarily; defaults to 'tmp'

Forked From

License

This plugin is released under the MIT License.