cb3d7118878a7e4ccc54bfc4b5cfe063df92eae5
[akkoma] / docs / installation / optional / media_graphics_packages.md
1 # Optional software packages needed for specific functionality
2
3 For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required:
4 * `ImageMagic`
5 * `ffmpeg`
6 * `exiftool`
7
8 Please refer to documentation in `docs/installation` on how to install them on specific OS.
9
10 Note: the packages are not required with the current default settings of Pleroma.
11
12 ## `ImageMagick`
13
14 `ImageMagick` is a set of tools to create, edit, compose, or convert bitmap images.
15
16 It is required for the following Pleroma features:
17 * `Pleroma.Upload.Filters.Mogrify`, `Pleroma.Upload.Filters.Mogrifun` upload filters (related config: `Plaroma.Upload/filters` in `config/config.exs`)
18 * Media preview proxy for still images (related config: `media_preview_proxy/enabled` in `config/config.exs`)
19
20 ## `ffmpeg`
21
22 `ffmpeg` is software to record, convert and stream audio and video.
23
24 It is required for the following Pleroma features:
25 * Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`)
26
27 ## `exiftool`
28
29 `exiftool` is media files metadata reader/writer.
30
31 It is required for the following Pleroma features:
32 * `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)