README.md

Image support within Etherpad

Plugin to upload images to Etherpad (https://etherpad.org/).

Supported storages:

• Base 64 - default
• Local (disk) storage
• Amazon S3

Base64

Images are converted to base64 and stored inside etherpad document Sample configuration in settings.json for using with base64:

"ep_image_upload": {
    "fileTypes": ["jpeg", "jpg", "bmp", "gif", "png"],
    "maxFileSize": 5000000
}

fileTypes - if left blank file mime-type is checked to match image.*

maxFileSize - file size in bytes. If not set there is no limit

Local (disk) storage

Local (disk) storage needs config for accessing files from web

Sample configuration in settings.json for using with local (disk) storage:

"ep_image_upload":{
    "storage":{
      "type": "local",
      "baseFolder": "/var/www/images",
      "baseURL": "http://www.my-site.com/images/"
    },
    "fileTypes": ["jpeg", "jpg", "bmp", "gif","png"],
    "maxFileSize": 5000000
  },

fileTypes - if left blank file mime-type is checked to match image.*

maxFileSize - file size in bytes. If not set there is no limit

baseURL - URL path to "baseFolder". For example if baseFolder is "/path/to/my_etherpad_folder/src/images" then http://myetherpad.com:9001/static/images/

Amazon S3 storage

Sample configuration in settings.json for using with Amazon S3:

"ep_image_upload":{
    "storage":{
      "type": "S3",
      "accessKeyId": "YOUR_S3_ACCESS_KEY",
      "secretAccessKey": "YOUR_S3_ACCESS_KEY_SECRET",
      "region": "YOUR_REGION",
      "bucket": "BUCKET_NAME",
      "baseFolder": "FOLDER_PATH"
    },
    "fileTypes": ["jpeg", "jpg", "bmp", "gif","png"],
    "maxFileSize": 5000000
  },

baseFolder - Path to filesystem folder that is publicly accessible from browser. For example to add images to Etherpad subfolder then /path/to/my_etherpad_folder/src/static/images

baseURL - URL path to baseFolder. For example if baseFolder is /path/to/my_etherpad_folder/src/images" then http://myetherpad.com:9001/static/images/

fileTypes - if left blank file mime-type is checked to match image.*

maxFileSize - file size in bytes. If not set there is no limit