gnu-social/plugins/StoreRemoteMedia/README.md
2021-07-16 19:44:42 +01:00

36 lines
1.3 KiB
Markdown

The StoreRemoteMedia plugin downloads remotely attached files to local server.
IMPORTANT: If using both Embed and StoreRemoteMedia plugins, Embed should be added first.
Installation
============
add `addPlugin('StoreRemoteMedia');`
to the bottom of your config.php
Settings
========
* `domain_whitelist`: Array of regular expressions. Always escape your dots and end your strings.
* `check_whitelist`: Whether to check the domain_whitelist.
When check_whitelist is set, only images from URLs matching a regex in the
domain_whitelist array are accepted for local storage.
* `thumbnail_width`: Maximum width of the thumbnail in pixels. Defaults to global `[thumbnail][width]`.
* `thumbnail_height`: Maximum height of the thumbnail in pixels. Defaults to global `[thumbnail][height]`.
* `crop`: Crop to the size (not preserving aspect ratio). Defaults to global `[thumbnail][crop]`.
* `max_size`: Max media size. Anything bigger than this is rejected. Defaults to global `[attachments][file_quota]`.
* `store_original`: Whether to maintain a copy of the original media or only a thumbnail of it. Defaults to false.
Example
=======
```
addPlugin('StoreRemoteMedia', [
'domain_whitelist' => [
'^i\d*\.ytimg\.com$' => 'YouTube',
'^i\d*\.vimeocdn\.com$' => 'Vimeo'
],
'check_whitelist' => true,
]);
```