gnu-social/plugins/Embed/README.md

32 lines
826 B
Markdown
Raw Normal View History

The Embed plugin for using and representing both Open Graph and oEmbed data.
2016-01-23 01:01:24 +09:00
See: https://ogp.me/ and https://www.oembed.com/
2016-01-23 01:01:24 +09:00
Installation
============
This plugin is enabled by default.
2016-01-23 01:01:24 +09:00
Settings
========
width: Maximum width of the thumbnail in pixels.
height: Maximum height of the thumbnail in pixels.
show_html: Whether to show HTML oEmbed data.
domain_whitelist: Array of regular expressions. Always escape your dots and end your strings.
check_whitelist: Whether to check the domain_whitelist.
Example
=======
```
2016-01-23 01:01:24 +09:00
$config['thumbnail']['width'] = 42;
$config['thumbnail']['height'] = 42;
$config['attachments']['show_html'] = true;
addPlugin('Embed', [
'domain_whitelist' => [
2016-01-23 01:01:24 +09:00
'^i\d*\.ytimg\.com$' => 'YouTube',
'^i\d*\.vimeocdn\.com$' => 'Vimeo'
],
2016-01-23 01:01:24 +09:00
'check_whitelist' => true
]
);
```