diff options
| author | lain <lain@soykaf.club> | 2020-09-29 14:48:30 +0000 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-09-29 14:48:30 +0000 |
| commit | 2a11068a11caa33bbd3fc66f175c5511f8ab2eaf (patch) | |
| tree | 13c139e46caed28ac358186f14cbc93cecccd3f2 /docs/installation/optional | |
| parent | aa170caa7698b0b6cafffa6f638c7f7495a9b989 (diff) | |
| parent | ae262846389aabfc71c12c2eb903cbe367140184 (diff) | |
| download | pleroma-2a11068a11caa33bbd3fc66f175c5511f8ab2eaf.tar.gz pleroma-2a11068a11caa33bbd3fc66f175c5511f8ab2eaf.zip | |
Merge branch 'ffmpeg-imagemagick-dependencies-documentation' into 'develop'
`ffmpeg` / `ImageMagick` handling as optional dependencies
See merge request pleroma/pleroma!3031
Diffstat (limited to 'docs/installation/optional')
| -rw-r--r-- | docs/installation/optional/media_graphics_packages.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/installation/optional/media_graphics_packages.md b/docs/installation/optional/media_graphics_packages.md new file mode 100644 index 000000000..cb3d71188 --- /dev/null +++ b/docs/installation/optional/media_graphics_packages.md @@ -0,0 +1,32 @@ +# 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` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`) |