summaryrefslogtreecommitdiff
path: root/docs/installation/optional/media_graphics_packages.md
blob: ad01d47d19ec0e62f04aa241145eff7af94f7226 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Optional software packages needed for specific functionality

For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required:

* `ImageMagic`
* `ffmpeg`
* `exiftool`
  
Please refer to documentation in `docs/installation` on how to install them on specific OS.
  
Note: the packages are not required with the current default settings of Pleroma.

## `ImageMagick`

`ImageMagick` is a set of tools to create, edit, compose, or convert bitmap images.

It is required for the following Pleroma features:

* `Pleroma.Upload.Filters.Mogrify`, `Pleroma.Upload.Filters.Mogrifun` upload filters (related config: `Plaroma.Upload/filters` in `config/config.exs`)
* Media preview proxy for still images (related config: `media_preview_proxy/enabled` in `config/config.exs`)
  
## `ffmpeg`

`ffmpeg` is software to record, convert and stream audio and video.

It is required for the following Pleroma features:

* Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`)

## `exiftool`

`exiftool` is media files metadata reader/writer.

It is required for the following Pleroma features:

* `Pleroma.Upload.Filters.Exiftool.StripLocation` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
* `Pleroma.Upload.Filters.Exiftool.ReadDescription` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)