-
Notifications
You must be signed in to change notification settings - Fork 1
/
kilowhat-rich-embeds.yml
177 lines (177 loc) · 9.09 KB
/
kilowhat-rich-embeds.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
kilowhat-rich-embeds:
admin:
settings:
layout: Layout
layoutOptions:
inline: Inline
block: Block
separated: Separated
position: Position
positionOptions:
replace: Replace link
above: Above link
below: Below link
style: Style
styleOptions:
vertical: Vertical
horizontal: Horizontal
maxImageCount: Maximum number of images in preview
maxImageCountHelp: >
How many images from Opengraph or fallback parser will be shown.
All image URLs are always saved, allowing you to change this setting later.
maxImageCountPlaceholder: Leave empty for unlimited
imageProxy: OpenGraph Image Proxy
imageProxyHelp: All OpenGraph and favicon images will be proxied through Flarum instead of being retrieved by the visitor browser
cacheProxy: Cache proxied images
cacheProxyHelp: The images will be cached to disk according to their HTTP headers
withoutOpengraph: Generate rich embeds for pages without OpenGraph data
withoutOpengraphHelp: Title, description and image will be scaped from the page HTML
blacklist: URL Blacklist
blacklistHelp: Check documentation for format. These URLs will never have rich embeds, and cannot be proxied through the image proxy
whitelist: URL Whitelist
whitelistHelp: Check documentation for format. If a value is set, all other URLs will be considered blacklisted
imageEmbeds: Rich Embeds for Images
imageEmbedsHelp: >
This feature retrieves and displays additional information on external images inserted in posts with bbcode or markdown.
At this time it re-uses the same blacklist/whitelist and permissions as rich links.
These images are not proxied through the OpenGraph image proxy.
You must clear the Flarum cache after changing this setting.
flarumApiPreviews: Enable advanced Flarum previews
flarumApiPreviewsHelp: >
This feature parses additional JSON data already included in the HTML by all Flarum-powered forums.
It will work with any forum that runs Flarum 1.4+ and advertises the <code>X-Powered-By</code> Flarum header.
githubApiKey: GitHub API Key
githubApiKeyHelp: Fill in to enable API-powered rich GitHub previews for repos, issues and PRs, including private repositories.
githubOrgWhitelist: Organisation whitelist
githubOrgWhitelistHelp: >
Comma-separated list of GitHub organisations that will use the API-powered preview.
Use this field to prevent every private repo accessible by the API key to be exposed, to reduce API usage or to only change the embed style of your own org.
If left empty, any repo that the API key can access can be previewed.
googleApiAuthConfig: Google SDK Auth Config Path or JSON
googleApiAuthConfigHelp: >
This setting is used in combination with YouTube and Google Drive settings below.
It should contain an absolute path to the JSON authentication file on the local file system, or the content of that file.
If left empty, an API key or service account will automatically be discovered via environment variables by the Google API SDK.
googleApiKey: Google SDK API key
googleApiKeyHelp: >
This setting is used in combination with YouTube and Google Drive settings below.
If left empty, an API key or service account will automatically be discovered via environment variables by the Google API SDK.
youtubePlayer: Allow playing YouTube videos from the preview
youtubePlayerHelp: >
An iframe player will be loaded on demand when the user clicks the play button in the preview.
You must configure your CSP and frame headers to allow frames from YouTube domain name.
This feature can be used without API access.
youtubeNoCookie: Use YouTube no-cookie iframe domain
youtubeNoCookieHelp: >
Switches to the alternate no-cookie domain offered by YouTube.
Some videos might not be able to play in the iframe with this option enabled.
This feature can be used without API access.
youtubeApiPreviews: Enable advanced API-powered rich YouTube previews
youtubeApiPreviewsHelp: >
The Google API SDK must be configured above.
This feature will show more statistics about videos and can show private videos the SDK user has access to.
googledriveApiPreviews: Enable advanced API-powered rich Google Drive previews
googledriveApiPreviewsHelp: >
The Google API SDK must be configured above.
This feature will show the title and preview of Google Drive files.
Use a service account with access to a private Drive to enable preview of private files.
section:
siteSpecificHelp: >
Below are site-specific settings that improve embeds using data not available through OpenGraph and HTML scraping.
All options are optional.
Some of the options require third-party API access which might come with rate limits or fees.
flarum: Flarum
github: GitHub
google: Google
youtube: YouTube
googledrive: Google Drive
permissions:
viewGoogleDriveThumbnails: View API-powered Google Drive thumbnails
useOnOwnPost: Use embeds in own post
disableOnOwnPost: Disable embeds on own post
refreshOnOwnPost: Refresh embeds on own post
disableOnAnyPost: Disable embeds on any post
refreshOnAnyPost: Refresh embeds on any post
preview:
title: Preview
refresh: Refresh
loading: Loading...
lib:
embed:
altFavicon: '{website} Icon'
altImageFallback: '{website} Opengraph Image'
altAvatar: Author avatar image
missing:
retrieving: Retrieving...
other: No preview could be generated for this link
controls:
refresh: Refresh data
disable: Disable embeds on this post
disableConfirmation: All embeds will be removed from this post. Continue?
imgCopy: Copy image URL
imgCopied: Copied!
imgOpen: Open image in new tab
play: Click to play media using an embedded player
expandDescription: Expand description
api:
error:
blacklistedUrl: URL {url} has not been whitelisted for embedding.
invalidUrl: URL {url} is not valid.
embed:
flarum:
discussion:
type: Discussion
stats:
commentCount: Replies
participantCount: Participants
createdAt: Start date
user:
type: Profile
avatarAlt: Avatar
stats:
discussionCount: Discussions
commentCount: Comments
joinTime: Join date
github:
siteName: GitHub
privateRepoSuffix: '[private]'
issue:
type: Issue
stats:
commentCount: Comments
createdAt: Created at
pull:
type: Pull request
stats:
commentCount: Comments
reviewCount: Reviews
commitCount: Commits
createdAt: Created at
repo:
type:
public: Public repository
private: Private repository
stats:
openIssueCount: Open issues
subscriberCount: Watchers
stargazerCount: Stars
forkCount: Forks
youtube:
siteName: YouTube
video:
type: Video
thumbnailAlt: Video thumbnail
stats:
viewCount: Views
likeCount: Likes
commentCount: Comments
publishedAt: Published at
googledrive:
siteName: Google Drive
file:
type: File
thumbnailAlt: Google Drive file preview
stats:
size: Filesize
createdTime: Created at
modifiedTime: Modified at