Merge branch 'master' into mmn_fixes

[quix0rs-gnu-social.git] / plugins / StoreRemoteMedia / README

diff --git a/plugins/StoreRemoteMedia/README b/plugins/StoreRemoteMedia/README
index a6bd91f605b3a425deac7575f26454966fec3d6b..2de4ce4541e27ea73301eacd88624e05411f5fef 100644 (file)
--- a/plugins/StoreRemoteMedia/README
+++ b/plugins/StoreRemoteMedia/README
@@ -7,9 +7,19 @@ to the bottom of your config.php
 
 Settings
 ========
+domain_blacklist: Array of regular expressions. Always escape your dots and end your strings.
+check_blacklist: Whether to check the domain_blacklist.
+
 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. When check_blacklist
+is set, images from URLs matching any regex in the domain_blacklist are
+denied local storage. When both lists are checked, only images from URLs
+that match a regex in the domain_whitelist and that match no regexen in the
+domain_blacklist are accepted for local storage.
+
 Example
 =======
 addPlugin('StoreRemoteMedia', array(
@@ -17,6 +27,6 @@ addPlugin('StoreRemoteMedia', array(
         '^i\d*\.ytimg\.com$' => 'YouTube',
         '^i\d*\.vimeocdn\.com$' => 'Vimeo'
     ),
-    'check_whitelist' => true
+    'check_whitelist' => true,
 ));