Plugin to store files on Amazon S3
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Locale/fr_FR Added config user interface and streams May 20, 2016
Template Update link to documentation Apr 4, 2018
Test Add unit tests for config getters Oct 12, 2016
vendor Update AWS SDK Oct 13, 2016
.gitignore Add travis Jan 30, 2016
.travis.yml Update CI config Mar 30, 2018
LICENSE
Makefile Update Makefile Oct 12, 2016
Plugin.php Rename CSS class Jan 8, 2017
README.md
S3Storage.php

README.md

AWS S3 plugin for Kanboard

Build Status

This plugin stores uploaded files to Amazon S3 instead of storing files on the local filesystem.

Author

  • Frederic Guillot
  • License MIT

Requirements

  • Kanboard >= 1.0.37
  • PHP >= 5.5
  • Amazon AWS account

Installation

You have the choice between 3 methods:

  1. Install the plugin from the Kanboard plugin manager in one click
  2. Download the zip file and decompress everything under the directory plugins/S3
  3. Clone this repository into the folder plugins/S3

Note: Plugin folder is case-sensitive.

Configuration

You can configure this plugin through the user interface or with the config file. Use the config file if you don't want to store AWS credentials into the database.

With the user interface

Go to Settings > Integrations > Amazon S3 Storage:

s3

With the config file

Add those config parameters in your config.php:

define('AWS_KEY', 'YOUR_API_KEY');
define('AWS_SECRET', 'YOUR_API_SECRET');
define('AWS_S3_BUCKET', 'YOUR_BUCKET_NAME');
define('AWS_S3_PREFIX', '');

// Set the region of your bucket
define('AWS_S3_REGION', 'us-east-1');

Notes

  • If the S3 prefix is defined, all files will be save to s3://YOUR_BUCKET/YOUR_PREFIX/path/to/object.