General configuration

WARNING

⚠️ change in v5.0.0

Attachment configuration is located in the config/attachment.ts file. By default, the file looks like this:

import { defineConfig } from '@jrmc/adonis-attachment'
import { InferConverters } from '@jrmc/adonis-attachment/types/config'

const attachmentConfig = defineConfig({
  converters: {
    thumbnail: {
      resize: 300,
    }
  }
})

export default attachmentConfig

declare module '@jrmc/adonis-attachment' {
  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
}

---

preComputeUrl (optional, default false)

enable the preComputeUrl flag to pre compute the URLs after SELECT queries.

const attachmentConfig = defineConfig({
  preComputeUrl: true, 
  converters: {
    // ...
  }
})

INFO

Alternate : please look the new route

meta (optional, default false)

you can set the default meta generation or not

const attachmentConfig = defineConfig({
  meta: true, 
  converters: {
    // ...
  }
})

---

rename (optional, default true)

You can define by default if the files are renamed or not.

const attachmentConfig = defineConfig({
  rename: false, 
  converters: {
    // ...
  }
})

rename can take a function for customization.

import type { LucidRow } from '@adonisjs/lucid/types/model'

const attachmentConfig = defineConfig({
  rename: (file: LucidRow, column?: string, currentName?: string) => { 
    return crypto.randomUUID() 
  }, 
  converters: {
    // ...
  }
})

---

bin (optional)

You may set the ffmpeg and ffprobe binary paths manually:

const attachmentConfig = defineConfig({
  bin: { 
    ffmpegPath: 'ffmpeg_path', // the full path of the binary
    ffprobePath: 'ffprobe_path', // the full path of the binary
    pdftoppmPath: 'pdftoppm_path' // the full path of the binary
    pdfinfoPath: 'pdfinfo_path' // the full path of the binary
    sofficePath: 'soffice_path', // the full path of the binary (libreoffice/openoffice)
  },
  converters: {
    // ...
  }
})

OPTIONS	DESCRIPTIONS:
ffmpegPath	Argument path is a string with the full path to the ffmpeg binary
ffprobePath	Argument path is a string with the full path to the ffprobe binary
pdftoppmPath	Argument path is a string with the path of the directory to the pdftoppm binary
pdfinfoPath	Argument path is a string with the path of the directory to the pdfinfo binary
sofficePath	Argument path to LibreOffice binary executables

sample

download ffmpeg and ffprobe binary in /bin. Add execution right.

cd bin
chmod +x ffmpeg
chmod +x ffprobe

import app from '@adonisjs/core/services/app'
import { defineConfig } from '@jrmc/adonis-attachment'
import { InferConverters } from '@jrmc/adonis-attachment/types/config'

const attachmentConfig = defineConfig({
  bin: { 
    ffmpegPath: app.makePath('bin/ffmpeg'),
    ffprobePath: app.makePath('bin/ffprobe'),
  },
  converters: [
    // ...
  ]
})

export default attachmentConfig

declare module '@jrmc/adonis-attachment' {
  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
}

queue concurrency (optional)

The convert processing is carried out async in a queue

By default, 1 task is processed concurrently. 1 task corresponds to a model attribute. For example, if a model has a logo attribute and an avatar attribute, this represents 2 tasks whatever the number of concert per attribute.

import app from '@adonisjs/core/services/app'
import { defineConfig } from '@jrmc/adonis-attachment'
import { InferConverters } from '@jrmc/adonis-attachment/types/config'

const attachmentConfig = defineConfig({
  queue: { 
    concurrency: 2
  },
  converters: {
    // ...
  }
})

export default attachmentConfig

declare module '@jrmc/adonis-attachment' {
  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
}

timeout (optional, Default 30000ms)

Maximum duration (in milliseconds) that an operation can take before being interrupted.

import app from '@adonisjs/core/services/app'
import { defineConfig } from '@jrmc/adonis-attachment'
import { InferConverters } from '@jrmc/adonis-attachment/types/config'

const attachmentConfig = defineConfig({
  timeout: 40_000,
  converters: {
    // ...
  }
})

export default attachmentConfig

declare module '@jrmc/adonis-attachment' {
  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
}

---

variant (optional)

⚠️ avalable in v5.1.0

Configure the storage path for generated variants.

INFO

In the examples below, image.jpg is used for clarity. In practice, filenames are automatically renamed to UUIDs (e.g., a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg) unless you set rename: false.

variant.basePath

Define a custom base path where all variants will be stored. By default, variants are stored in the same folder as the original file.

const attachmentConfig = defineConfig({
  variant: { 
    basePath: 'variants',
  },
  converters: {
    // ...
  }
})

Example with folder: 'avatars' on the attachment:

Option	Original path	Variant path
Without basePath	avatars/image.jpg	avatars/image.jpg/thumbnail.jpg
With basePath: 'variants'	avatars/image.jpg	variants/avatars/image.jpg/thumbnail.jpg

variant.ignoreFolder

When set to true, the variant will not include the parent folder from the original attachment.

const attachmentConfig = defineConfig({
  variant: { 
    ignoreFolder: true,
  },
  converters: {
    // ...
  }
})

Example with folder: 'avatars' on the attachment:

Option	Original path	Variant path
Without ignoreFolder	avatars/image.jpg	avatars/image.jpg/thumbnail.jpg
With ignoreFolder: true	avatars/image.jpg	image.jpg/thumbnail.jpg

Combined options

You can combine both options to have full control over variant storage:

const attachmentConfig = defineConfig({
  variant: { 
    basePath: 'all-variants',
    ignoreFolder: true,
  },
  converters: {
    // ...
  }
})

Example with folder: 'avatars' on the attachment:

Options	Original path	Variant path
basePath + ignoreFolder	avatars/image.jpg	all-variants/image.jpg/thumbnail.jpg

Use case

This is useful when you want to store all variants in a dedicated folder, separate from the original files. For example, you might want to use a different storage disk or CDN for variants.