docs: Clarify that users should modify rather than replace the enabledPreviewProviders array

pull/743/head
Frank J. Gómez 2023-07-16 09:04:26 +00:00 committed by GitHub
parent 84760d6266
commit c3f550a5fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 19 deletions

View File

@ -4,7 +4,9 @@ description: Steps to configure support for different image and video formats
# File type support # File type support
Memories supports the file types supported by the Nextcloud previews app. If you add support for any one of the file types below, you must run `occ memories:index` to index these files. Memories supports the file types supported by the Nextcloud previews app. File type support is determined in part by the values listed in the `enabledPreviewProviders` configuration parameter in your configuration file. If your `config.php` does not contain an `enabledPreviewProviders` array, this means you are using Nextcloud's defaults. Copy the array over from `config.sample.php` before adding any of the values below, or else you will effectively disable all of the defaults.
If you add support for any one of the file types below, you must run `occ memories:index` to index these files.
## Common Formats ## Common Formats
@ -15,40 +17,43 @@ GIF (image/gif)
BMP (image/bmp) BMP (image/bmp)
``` ```
These are enabled by having the following in your `config.php`, These are enabled by inclusion of the following values in `config.php`'s `enabledPreviewProviders` array:
```php ```php
'enabledPreviewProviders' => 'OC\Preview\Image',
array ( ```
'OC\\Preview\\Image',
), ... or...
```php
'OC\Preview\PNG',
'OC\Preview\JPEG',
'OC\Preview\GIF',
'OC\Preview\BMP',
'OC\Preview\XBitmap',
``` ```
## HEIC and TIFF ## HEIC and TIFF
You must enable `HEIC` and `TIFF` in Nextcloud `config.php`, and install Imagemagick (included in the official Nextcloud docker image) These are enabled by inclusion of the following values in `config.php`'s `enabledPreviewProviders` array:
In `config.php`, add,
```php ```php
'enabledPreviewProviders' => 'OC\Preview\HEIC',
array ( 'OC\Preview\TIFF',
'OC\\Preview\\HEIC',
'OC\\Preview\\TIFF',
),
``` ```
You must also install Imagemagick (included in the official Nextcloud docker image).
## Videos ## Videos
You need to install `ffmpeg` and add the video config to `config.php` These are enabled by inclusion of the following value in `config.php`'s `enabledPreviewProviders` array:
```php ```php
'enabledPreviewProviders' => 'OC\Preview\Movie',
array (
'OC\\Preview\\Movie',
),
``` ```
You must also install `ffmpeg` and add the video config to `config.php`.
## RAW images ## RAW images
Install the [camera raw previews](https://github.com/ariselseng/camerarawpreviews) app from the Nextcloud app store. Install the [camera raw previews](https://github.com/ariselseng/camerarawpreviews) app from the Nextcloud app store.