ep_image_insert

Image support within Etherpad with resize

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

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

Installation

cd /path/to/etherpad-lite
# The `--no-save` and `--legacy-peer-deps` arguments are necessary to work
# around npm quirks.
npm install --no-save --legacy-peer-deps ep_image_insert

Base64

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

"ep_image_insert": {
    "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_insert":{
    "storage":{
      "type": "local",
      "baseFolder": "src/static/images",
      "baseURL": "http://www.my-site.com/static/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/static/images" then http://myetherpad.com:9001/static/images/

Amazon S3 storage

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

"ep_image_insert":{
    "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
  },