Extensions:Screenshot Meta Tag Images

From Lorekeeper Wiki
Revision as of 20:55, 10 March 2021 by Mercury (talk | contribs)
Jump to navigation Jump to search
Screenshot Meta Tag Images
Description Adds support for page screenshots as meta tag images.
Author(s) Mercury
Status Stable
Github screenshot-meta-img
LK Version Unspecified




Built on __develop__.

Adds support for screenshots as the meta tag/preview image (on twitter, discord, etc.) captured from the page as viewed at the time. This is accomplished via use of the thum.io API; note that while up to 1000 screenshots are available per month free, beyond this requires a paid account. However, this service was selected in particular due to being fairly lenient in its free limit and affordable beyond that.

Installation

  1. Sign up for a thum.io account. Make a key; this can be called whatever you want.
  2. On the dashboard, click "keys", then "more info" next to the key you made. Click "Edit key" at the bottom of the page.
  3. Set "Type" to "MD5". Click "Save".
  4. Record the ID and Secret Key displayed.
  5. Add the following values to your .env file:

THUM_IO_ID=your_id_here

THUM_IO_KEY=your_secret_key_here

  1. Pull the branch.

Configuration

None required.

Usage

Screenshot images should display with the rest of the meta tag information automatically (for pages without specifically set preview images) when a page on the site is linked.

Troubleshooting

Find me in the Lorekeeper server!

See Also