Installation

The Adonis Attachment package is available on npm.

It's required Adonis Drive, please look at the documentation if this is not installed.

You can install it using the following ace command to automagically configure it:

# V4 stable
node ace add @jrmc/adonis-attachment

# V5 beta
node ace add @jrmc/adonis-attachment@beta

Alternatively, you can install it manually using your favorite package manager and running the configure command:

npm

npm install @jrmc/adonis-attachment
node ace configure @jrmc/adonis-attachment

pnpm

pnpm install @jrmc/adonis-attachment
node ace configure @jrmc/adonis-attachment

yarn

yarn add @jrmc/adonis-attachment
node ace configure @jrmc/adonis-attachment

INFO

Doc for v4 stable ⚠️ v4.x.x

Additional install

Variants images are generates by sharp module and require installation:

npm

npm install sharp

pnpm

pnpm install sharp

yarn

yarn add sharp

---

Variants images for thumbnail PDF are generates by poppler(pdftoppm and pdfinfo) installed on your system.

It is possible to specify the path of binaries. Useful if your installations are specific or if you are dropping off precompiled versions.

Installation required:

linux

sudo apt-get install poppler-data poppler-utils

mac

brew install poppler

---

Variants images for thumbnail Document are generates by LibreOffice installed on your system.

It is possible to specify the path of binaries. Useful if your installations are specific or if you are dropping off precompiled versions.

---

Variants images for thumbnail video are generates by ffmpeg installed on your system (including all necessary encoding libraries like libmp3lame or libx264).

It is possible to specify the path of binaries. Useful if your installations are specific or if you are dropping off precompiled versions.

Installation required:

linux

sudo apt-get install ffmpeg

mac

brew install ffmpeg