mirror of
https://github.com/wassname/talk.git
synced 2026-09-12 13:01:11 +08:00
added plugin directory
This commit is contained in:
Wyatt Johnson
@@ -56,50 +56,6 @@ When `TRUE`, it will not mount the static asset serving routes on the router.
|
||||
This is used primarily in conjunction with [TALK_STATIC_URI](#talk_static_uri)
|
||||
when the static assets are being hosted on an external domain. (Default `FALSE`)
|
||||
|
||||
## TALK_FACEBOOK_APP_ID
|
||||
|
||||
The Facebook App ID for your Facebook Login enabled app. You can learn more
|
||||
about getting a Facebook App ID at the
|
||||
[Facebook Developers Portal](https://developers.facebook.com)
|
||||
or by visiting the
|
||||
[Creating an App ID](https://developers.facebook.com/docs/apps/register)
|
||||
guide. This is only required while the `talk-plugin-facebook-auth` plugin is
|
||||
enabled.
|
||||
|
||||
## TALK_FACEBOOK_APP_SECRET
|
||||
|
||||
The Facebook App Secret for your Facebook Login enabled app. You can learn more
|
||||
about getting a Facebook App Secret at the
|
||||
[Facebook Developers Portal](https://developers.facebook.com)
|
||||
or by visiting the
|
||||
[Creating an App ID](https://developers.facebook.com/docs/apps/register)
|
||||
guide. This is only required while the `talk-plugin-facebook-auth` plugin is
|
||||
enabled.
|
||||
|
||||
## TALK_GOOGLE_CLIENT_ID
|
||||
|
||||
The Google OAuth2 client ID for your Google login web app. You can learn more
|
||||
about getting a Google Client ID at the
|
||||
[Google API Console](https://console.developers.google.com/apis/){:target="_blank"}.
|
||||
|
||||
You will need to enable the Google+ API in the dashboard and create credentials
|
||||
for a new OAuth client ID web application. The authorized JavaScript origin
|
||||
should be set to the Talk domain, and the authorized redirect URI should be set
|
||||
to http://<example.com>/api/v1/auth/google/callback. This is only required while
|
||||
the `talk-plugin-google-auth` plugin is enabled.
|
||||
|
||||
## TALK_GOOGLE_CLIENT_SECRET
|
||||
|
||||
The Google OAuth2 client ID for your Google login web app. You can learn more
|
||||
about getting a Google Client ID at the
|
||||
[Google API Console](https://console.developers.google.com/apis/){:target="_blank"}.
|
||||
|
||||
You will need to enable the Google+ API in the dashboard and create credentials
|
||||
for a new OAuth client ID web application. The authorized JavaScript origin
|
||||
should be set to the Talk domain, and the authorized redirect URI should be set
|
||||
to http://<example.com>/api/v1/auth/google/callback. This is only required while
|
||||
the `talk-plugin-google-auth` plugin is enabled.
|
||||
|
||||
## TALK_HELMET_CONFIGURATION
|
||||
|
||||
A JSON string representing the configuration passed to the
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: Plugins Overview
|
||||
permalink: /plugins/
|
||||
---
|
||||
|
||||
There are several ways to install plugins.
|
||||
|
||||
### Default Plugins vs. Custom Plugins
|
||||
|
||||
Talk ships with a default set of plugins, available in `plugins.default.json`. When you run Talk with just the default plugins, these are the plugins that will be enabled.
|
||||
|
||||
If you want to use the additional plugins that are available, you can create a `plugins.json` file. If this file exists, Talk will use that to determine which plugins to use.
|
||||
|
||||
### Installing a Plugin from npm
|
||||
|
||||
|
||||
If you create your own plugin, you can publish the plugin to npm and use it in Talk. The npm package can be public (open source) or private.
|
||||
|
||||
You would include this in your `plugins.json`:
|
||||
|
||||
EXAMPLE HERE
|
||||
|
||||
### Installing a Local Plugin
|
||||
|
||||
If you host your own plugin on Github, you can enable it by adding this to your `plugins.json`:
|
||||
|
||||
EXAMPLE HERE
|
||||
|
||||
### Best Practice
|
||||
|
||||
|
||||
|
||||
@@ -1,148 +0,0 @@
|
||||
---
|
||||
title: Default Plugins
|
||||
permalink: /default-plugins/
|
||||
class: configuration
|
||||
toc: true
|
||||
---
|
||||
|
||||
The default Talk plugins can be found in the `plugins.default.json` file
|
||||
[here](https://github.com/coralproject/talk/blob/master/plugins.default.json).
|
||||
Talk ships out of the box with these plugins enabled.
|
||||
|
||||
We ship [Additional Plugins](./additional-plugins/) with
|
||||
Talk that are not enabled by default. You can enable these or disable these
|
||||
default plugins by consulting the [Plugins Overview](./plugins/)
|
||||
page.
|
||||
|
||||
## talk-plugin-auth
|
||||
|
||||
Source: [plugins/talk-plugin-auth](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-auth)
|
||||
|
||||
Enables generic registration via an email address, a username, a password, and a
|
||||
password confirmation. To sync Talk auth with your own auth systems, you can use
|
||||
this plugin as a template.
|
||||
|
||||
## talk-plugin-facebook-auth
|
||||
|
||||
Source: [plugins/talk-plugin-auth](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-auth)
|
||||
|
||||
Requires: [talk-plugin-facebook-auth](#talk-plugin-facebook-auth)
|
||||
|
||||
Enables sign-in via Facebook via the server side passport middleware.
|
||||
|
||||
Configuration:
|
||||
|
||||
- [TALK_FACEBOOK_APP_ID](./configuration/#talk_facebook_app_id) (**required**) - See the existing documentation for the [TALK_FACEBOOK_APP_ID](./configuration/#talk_facebook_app_id).
|
||||
- [TALK_FACEBOOK_APP_SECRET](./configuration/#talk_facebook_app_secret) (**required**) - See the existing documentation for the [TALK_FACEBOOK_APP_SECRET](./configuration/#talk_facebook_app_secret).
|
||||
|
||||
## talk-plugin-featured-comments
|
||||
|
||||
Source: [plugins/talk-plugin-featured-comments](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-featured-comments)
|
||||
|
||||
Enables the ability for Moderators to feature and un-feature comments via the
|
||||
Stream and the Admin. Featured comments show in a first-place tab on the Stream
|
||||
if there are any featured comments on that story.
|
||||
|
||||
## talk-plugin-respect
|
||||
|
||||
Source: [plugins/talk-plugin-respect](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-respect)
|
||||
|
||||
Enables a `respect` reaction button. Why a "respect" button, you ask?
|
||||
[Read more here](https://mediaengagement.org/research/engagement-buttons/).
|
||||
|
||||
## talk-plugin-comment-content
|
||||
|
||||
Source: [plugins/talk-plugin-comment-content](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-comment-content)
|
||||
|
||||
Pluginizes the text of a comment to support custom treatment of this text. This
|
||||
plugin currently parses the given text to see if it contains a link, and makes
|
||||
them clickable.
|
||||
|
||||
## talk-plugin-ignore-user
|
||||
|
||||
Source: [plugins/talk-plugin-ignore-user](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-ignore-user)
|
||||
|
||||
Enables ability for users to ignore (or "mute") other users. If a user is
|
||||
ignored, you will not see any of their comments. You can un-ignore a user via
|
||||
the My Profile tab.
|
||||
|
||||
## talk-plugin-permalink
|
||||
|
||||
Source: [plugins/talk-plugin-permalink](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-permalink)
|
||||
|
||||
Enables a `Link` button that will provide a permalink to the comment that can be
|
||||
shared with others.
|
||||
|
||||
## talk-plugin-viewing-options
|
||||
|
||||
Source: [plugins/talk-plugin-viewing-options](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-viewing-options)
|
||||
|
||||
Pluginizes the sorting/viewing options for a comment stream.
|
||||
|
||||
## talk-plugin-sort-newest
|
||||
|
||||
Source: [plugins/talk-plugin-sort-newest](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-newest)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options)
|
||||
|
||||
Provides a sort for the newest comments first. This isn't necessarily required
|
||||
as the default sort without options/plugins is newest first.
|
||||
|
||||
## talk-plugin-sort-oldest
|
||||
|
||||
Source: [plugins/talk-plugin-sort-oldest](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-oldest)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options)
|
||||
|
||||
Provides a sort for the newest comments first.
|
||||
|
||||
## talk-plugin-sort-most-respected
|
||||
|
||||
Source: [plugins/talk-plugin-sort-most-respected](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-respected)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options), [talk-plugin-respect](#talk-plugin-respect)
|
||||
|
||||
Provides a sort for the comments with the most `respect` reactions first.
|
||||
|
||||
## talk-plugin-sort-most-replied
|
||||
|
||||
Source: [plugins/talk-plugin-sort-most-replied](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-replied)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](#talk-plugin-viewing-options)
|
||||
|
||||
Provides a sort for the comments with the most replies first.
|
||||
|
||||
## talk-plugin-offtopic
|
||||
|
||||
Source: [plugins/talk-plugin-offtopic](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-offtopic)
|
||||
|
||||
Allows the comment authors to tag their comment as `Off-Topic` which will add a
|
||||
visible badge on the frontend to other users that their comment is off-topic.
|
||||
|
||||
## talk-plugin-author-menu
|
||||
|
||||
Source: [plugins/talk-plugin-author-menu](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-author-menu)
|
||||
|
||||
Pluginizes the author's name on hover.
|
||||
|
||||
## talk-plugin-member-since
|
||||
|
||||
Source: [plugins/talk-plugin-member-since](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-member-since)
|
||||
|
||||
Requires: [talk-plugin-author-menu](#talk-plugin-author-menu)
|
||||
|
||||
Displays the date that the user was created as a `Member Since ${created_at}`.
|
||||
|
||||
## talk-plugin-moderation-actions
|
||||
|
||||
Source: [plugins/talk-plugin-moderation-actions](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-moderation-actions)
|
||||
|
||||
Enables in-stream moderation so that Moderators can reject, approve comments,
|
||||
as well as ban users, directly from the comment stream. When [talk-plugin-featured-comments](#talk-plugin-featured-comments) is enabled
|
||||
|
||||
## talk-plugin-flag-details
|
||||
|
||||
Source: [plugins/talk-plugin-flag-details](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-flag-details)
|
||||
|
||||
Pluginizes the Flag Details area of comments in the Moderation Queues to display
|
||||
data. Some basic details are already included on flags by default.
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
title: Additional Plugins
|
||||
permalink: /additional-plugins/
|
||||
class: configuration
|
||||
toc: true
|
||||
---
|
||||
|
||||
Talk ships with several plugins that aren't enabled by default. These plugins
|
||||
can be enabled by consulting the [Plugins Overview](./plugins/)
|
||||
page.
|
||||
|
||||
## talk-plugin-like
|
||||
|
||||
Source: [plugins/talk-plugin-like](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-like)
|
||||
|
||||
Enables a `like` reaction button.
|
||||
|
||||
## talk-plugin-sort-most-liked
|
||||
|
||||
Source: [plugins/talk-plugin-sort-most-liked](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-liked)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](./default-plugins/#talk-plugin-viewing-options), [talk-plugin-like](#talk-plugin-like)
|
||||
|
||||
Provides a sort for the comments with the most `like` reactions first.
|
||||
|
||||
## talk-plugin-love
|
||||
|
||||
Source: [plugins/talk-plugin-love](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-love)
|
||||
|
||||
Enables a `love` reaction button.
|
||||
|
||||
## talk-plugin-sort-most-loved
|
||||
|
||||
Source: [plugins/talk-plugin-sort-most-loved](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-sort-most-loved)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](./default-plugins/#talk-plugin-viewing-options), [talk-plugin-love](#talk-plugin-love)
|
||||
|
||||
Provides a sort for the comments with the most `love` reactions first.
|
||||
|
||||
## talk-plugin-remember-sort
|
||||
|
||||
Source: [plugins/talk-plugin-remember-sort](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-remember-sort)
|
||||
|
||||
Requires: [talk-plugin-viewing-options](./default-plugins/#talk-plugin-viewing-options)
|
||||
|
||||
Enables saving a user’s last sort selection as they browse other articles.
|
||||
|
||||
## talk-plugin-deep-reply-count
|
||||
|
||||
Source: [plugins/talk-plugin-deep-reply-count](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-deep-reply-count)
|
||||
|
||||
Enables counting of comments to include replies via a new graph edge. Not
|
||||
recommended for large installations as it will unreasonably reduce the query
|
||||
efficiency to compute this number.
|
||||
|
||||
## talk-plugin-slack-notifications
|
||||
|
||||
Source: [plugins/talk-plugin-slack-notifications](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-slack-notifications)
|
||||
|
||||
Enables all new comments that are written to be posted to a Slack channel as
|
||||
well. Configure an
|
||||
[Incoming Webhook](https://api.slack.com/incoming-webhooks)
|
||||
app and provide that url in the form of the `SLACK_WEBHOOK_URL`
|
||||
detailed below.
|
||||
|
||||
*Warning: On high volume sites, this means every single comment will flow into
|
||||
Slack, if this isn't what you want, be sure to use the provided plugin as a
|
||||
recipe to further customize the behavior*.
|
||||
|
||||
Configuration:
|
||||
|
||||
- `SLACK_WEBHOOK_URL` (**required**) - The webhook url that will be
|
||||
used to post new comments to.
|
||||
|
||||
## talk-plugin-toxic-comments
|
||||
|
||||
Source: [plugins/talk-plugin-toxic-comments](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-toxic-comments)
|
||||
|
||||
Using the [Perspective API](http://perspectiveapi.com/), this
|
||||
plugin will warn users and reject comments that exceed the predefined toxicity
|
||||
threshold. For more information on what Toxic Comments are, check out the
|
||||
[Toxic Comments](./toxic-comments/) documentation.
|
||||
|
||||
Configuration:
|
||||
|
||||
- `TALK_PERSPECTIVE_API_KEY` (**required**) - The API Key for Perspective. You
|
||||
can register and get your own key at [http://perspectiveapi.com/](http://perspectiveapi.com/).
|
||||
- `TALK_TOXICITY_THRESHOLD` - If the comments toxicity exceeds this threshold,
|
||||
the comment will be rejected. (Default `0.8`)
|
||||
- `TALK_PERSPECTIVE_API_ENDPOINT` - API Endpoint for hitting the
|
||||
perspective API. (Default `https://commentanalyzer.googleapis.com/v1alpha1`)
|
||||
- `TALK_PERSPECTIVE_TIMEOUT` - The timeout for sending a comment to
|
||||
be processed before it will skip the toxicity analysis, parsed by
|
||||
[ms](https://www.npmjs.com/package/ms). (Default `300ms`)
|
||||
- `TALK_PERSPECTIVE_DO_NOT_STORE` - Whether the API is permitted to store comment and context from this request. Stored comments will be used for future research and community model building purposes to improve the API over time. (Default `true`) [Perspective API - Analize Comment Request](https://github.com/conversationai/perspectiveapi/blob/master/api_reference.md#analyzecomment-request)
|
||||
|
||||
## talk-plugin-subscriber
|
||||
|
||||
Source: [plugins/talk-plugin-subscriber](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-subscriber)
|
||||
|
||||
Enables a `Subscriber` badge to be added to comments where the author has the
|
||||
`SUBSCRIBER` tag. This must match with a custom auth integration that adds the
|
||||
tag to the users that are subscribed to the service.
|
||||
|
||||
## talk-plugin-akismet
|
||||
|
||||
Source: [plugins/talk-plugin-akismet](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-akismet)
|
||||
|
||||
Enables spam detection from [Akismet](https://akismet.com/). Comments will be passed to the Akismet API for spam detection. If a comment
|
||||
is determined to be spam, it will prompt the user, indicating that the comment might be considered spam. If the user continues after this
|
||||
point with the still spam-like comment, the comment will be reported as containing spam, and sent for moderator approval.
|
||||
|
||||
**Note: [Akismet](https://akismet.com/) is a premium service, charges may apply.**
|
||||
|
||||
Configuration:
|
||||
|
||||
- `TALK_AKISMET_API_KEY` (**required**) - The Akismet API key located on your account page.
|
||||
- `TALK_AKISMET_SITE` (**required**) - The URL where you are embedding the comment stream on to provide context to Akismet. If you're hosting talk on https://talk.mynews.org/, and your news site is https://mynews.org/, then you should set this parameter to `https://mynews.org/`
|
||||
|
||||
## talk-plugin-notifications
|
||||
|
||||
Source: [plugins/talk-plugin-notifications](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications){:target="_blank"}
|
||||
|
||||
Enables the Notification system for sending out enabled email notifications to
|
||||
users when they interact with Talk. By itself, this plugin will not send
|
||||
anything. You need to enable one of the `talk-plugin-notifications-category-*` plugins.
|
||||
|
||||
**Note that all `talk-plugin-notifications-*` plugins must be registered
|
||||
*before* this plugin in order to work. For example:**
|
||||
|
||||
```js
|
||||
{
|
||||
"server": [
|
||||
// ...
|
||||
"talk-plugin-notifications-category-reply",
|
||||
"talk-plugin-notifications",
|
||||
// ...
|
||||
]
|
||||
}
|
||||
```
|
||||
{:.no-copy}
|
||||
|
||||
Configuration:
|
||||
|
||||
- `DISABLE_REQUIRE_EMAIL_VERIFICATIONS` - When `TRUE`, it will disable the verification email check before sending notifications for those emails. **Note that organizations implementing a custom authentication system _must_ disable this feature, as they don't use our integrated auth**. (Default `FALSE`).
|
||||
|
||||
### talk-plugin-notifications-category-reply
|
||||
{:.param}
|
||||
|
||||
Source: [plugins/talk-plugin-notifications-category-reply](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications-category-reply){:target="_blank"}
|
||||
|
||||
Replies made to each user will trigger an email to be sent with the notification
|
||||
details if enabled.
|
||||
|
||||
### talk-plugin-notifications-category-featured
|
||||
{:.param}
|
||||
|
||||
Source: [plugins/talk-plugin-notifications-category-featured](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications-category-featured){:target="_blank"}
|
||||
|
||||
When a comment is featured (via the `talk-plugin-featured-comments` plugin), the
|
||||
user will receive a notification email.
|
||||
|
||||
### talk-plugin-notifications-category-staff
|
||||
{:.param}
|
||||
|
||||
Source: [plugins/talk-plugin-notifications-category-staff](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications-category-staff){:target="_blank"}
|
||||
|
||||
Replies made to each user by a staff member will trigger an email to be sent
|
||||
with the notification details if enabled.
|
||||
@@ -0,0 +1,72 @@
|
||||
- name: talk-plugin-akismet
|
||||
description: Enables auto-moderation from Akismet.
|
||||
- name: talk-plugin-auth
|
||||
description: Enables internal authentication from Coral.
|
||||
- name: talk-plugin-author-menu
|
||||
description: Enables the comment author name plugin area.
|
||||
- name: talk-plugin-comment-content
|
||||
description: Linkifies comment content that contains links.
|
||||
- name: talk-plugin-deep-reply-count
|
||||
description: Enables deep reply count graph edge including all decendant replies.
|
||||
- name: talk-plugin-facebook-auth
|
||||
description: Enables a Facebook login strategy.
|
||||
- name: talk-plugin-featured-comments
|
||||
description: Allows comments to be featured for other users.
|
||||
- name: talk-plugin-flag-details
|
||||
description: Show flag details in the admin panel.
|
||||
- name: talk-plugin-google-auth
|
||||
description: Enables a Google login strategy.
|
||||
- name: talk-plugin-ignore-user
|
||||
description: Allows other users to ignore one another to hide their comments from view.
|
||||
- name: talk-plugin-like
|
||||
description: Allows the like reaction for comments
|
||||
- name: talk-plugin-love
|
||||
description: Allows the love reaction for comments
|
||||
- name: talk-plugin-member-since
|
||||
description: Shows the users created at time as their member since date.
|
||||
- name: talk-plugin-moderation-actions
|
||||
description: Allows moderators to take actions on comments from the comment stream.
|
||||
- name: talk-plugin-notifications
|
||||
description: The base notification plugin which enables notifications to be sent.
|
||||
- name: talk-plugin-notifications-category-featured
|
||||
description: Enables the on-featured notification.
|
||||
- name: talk-plugin-notifications-category-reply
|
||||
description: Enables the on-reply notification.
|
||||
- name: talk-plugin-notifications-category-staff
|
||||
description: Enables the on-staff-reply notification.
|
||||
- name: talk-plugin-notifications-digest-daily
|
||||
description: Enables daily digesting of comment notifications as an option.
|
||||
- name: talk-plugin-notifications-digest-hourly
|
||||
description: Enables hourly digesting of comment notifications as an option.
|
||||
- name: talk-plugin-offtopic
|
||||
description: Allows users to mark a comment as off-topic when they create it.
|
||||
- name: talk-plugin-permalink
|
||||
description: Shows a Link button on comments for direct-linking to a comment.
|
||||
- name: talk-plugin-remember-sort
|
||||
description: Remembers the sort selection made by a user.
|
||||
- name: talk-plugin-respect
|
||||
description: Enables the respect reaction for comments.
|
||||
- name: talk-plugin-rich-text
|
||||
description: Enables rich text plugins that save data as HTML.
|
||||
- name: talk-plugin-rich-text-pell
|
||||
description: Enables the pell rich text editor.
|
||||
- name: talk-plugin-slack-notifications
|
||||
description: Sends all comments as notifications to a slack channel
|
||||
- name: talk-plugin-sort-most-liked
|
||||
description: Enables sorting by most liked.
|
||||
- name: talk-plugin-sort-most-loved
|
||||
description: Enables sorting by most loved.
|
||||
- name: talk-plugin-sort-most-replied
|
||||
description: Enables sorting by most replied.
|
||||
- name: talk-plugin-sort-most-respected
|
||||
description: Enables sorting by most respected.
|
||||
- name: talk-plugin-sort-newest
|
||||
description: Enables sorting by newest.
|
||||
- name: talk-plugin-sort-oldest
|
||||
description: Enables sorting by oldest.
|
||||
- name: talk-plugin-subscriber
|
||||
description: Shows a subscriber tag on users that have the tag in the database.
|
||||
- name: talk-plugin-toxic-comments
|
||||
description: Enables auto-moderation from Google's Perspective API.
|
||||
- name: talk-plugin-viewing-options
|
||||
description: Enables the dropdown used to display sorting options on the embed stream.
|
||||
@@ -1,17 +1,39 @@
|
||||
---
|
||||
title: Authenticating with Talk
|
||||
permalink: /authentication/
|
||||
permalink: /integrating/authentication/
|
||||
---
|
||||
|
||||
You can integrate Talk with any external authentication service that will enable
|
||||
seamless single sign-on for users within your organization. There are a few
|
||||
methods of doing so:
|
||||
|
||||
1. Passport Middleware
|
||||
2. Custom Token Integration
|
||||
|
||||
Both methods work, but there are product decisions that will affect the overall
|
||||
choice.
|
||||
|
||||
## Passport Middleware
|
||||
|
||||
You would choose the **Passport Middleware** route when you are OK using an auth
|
||||
that is triggered from inside Talk that is not connected to an external auth
|
||||
state (you don't use the auth anywhere else now). A great example of this is our
|
||||
Facebook plugin.
|
||||
|
||||
## Custom Token Integration
|
||||
|
||||
You can integrate Talk with any authentication service to enable single sign-on for users. The steps to do that are:
|
||||
|
||||
### Create auth middleware
|
||||
## Create auth middleware
|
||||
|
||||
Create a middleware service that generates a JWT, which is passed as an option to the Talk embed code (see https://github.com/coralproject/talk/blob/master/client/coral-embed/src/index.js#L36) OR embed bridge (see https://github.com/coralproject/talk/blob/master/client/coral-embed/src/index.js#L44).
|
||||
|
||||
### Generate a key to sign the JWT
|
||||
## Generate a key to sign the JWT
|
||||
|
||||
Use https://github.com/coralproject/coralcert to generate a key with which to sign the JWTs and specify the secret as an environment variable (see https://coralproject.github.io/talk/advanced-configuration/#talk_jwt_secret).
|
||||
|
||||
You may also provide configuration for other optional JWT components (see https://coralproject.github.io/talk/advanced-configuration/#).
|
||||
|
||||
### Create server plugin to handle auth
|
||||
## Create server plugin to handle auth
|
||||
|
||||
Provide an implementation for the tokenUserNotFound hook within a server side plugin (see https://github.com/coralproject/talk/blob/ef49d9a3d2acc4d2fc03b00e0c872dfbc57f005a/docs/_docs/04-04-plugins-server.md#field-tokenusernotfound)
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring the Talk Admin
|
||||
permalink: /configuring-admin/
|
||||
permalink: /integrating/configuring-admin/
|
||||
---
|
||||
|
||||
Using plugins and configuration variables, you can modify the way the Admin looks and how moderation works.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring the Talk Comment Stream
|
||||
permalink: /configuring-comment-stream/
|
||||
permalink: /integrating/configuring-comment-stream/
|
||||
---
|
||||
|
||||
Using plugins and configuration variables, you can modify the way the Talk comment stream behaves. Here are some common configuration options:
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Tracking Talk Events and Metrics
|
||||
permalink: /event-tracking-metrics/
|
||||
permalink: /integrating/event-tracking-metrics/
|
||||
---
|
||||
|
||||
Talk supports event emitting via Redux, Apollo and GraphQL. This means that common actions taken within Talk, such as successfully posting a comment, posting a reaction, or changing a setting, are automatically emitted from Talk. To send these events to your analytics tool of choice, however, will require some integration on your part.
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Notifications
|
||||
permalink: /notifications/
|
||||
permalink: /integrating/notifications/
|
||||
---
|
||||
|
||||
Talk currently supports 3 types of email notifications.
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Styling Talk with CSS
|
||||
permalink: /styling-css/
|
||||
permalink: /integrating/styling-css/
|
||||
---
|
||||
|
||||
You can add your own stylesheet in Admin > Configure > Tech Settings.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Translations and i18n
|
||||
permalink: /translations-i18n/
|
||||
permalink: /integrating/translations-i18n/
|
||||
---
|
||||
|
||||
We’re so proud to have received submissions from a lot of 3rd party contributors translating Talk into their own languages.
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-akismet/README.md
|
||||
+1
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-auth/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-author-menu/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-comment-content/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-deep-reply-count/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-facebook-auth/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-featured-comments/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-flag-details/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-google-auth/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-ignore-user/README.md
|
||||
+1
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-like/README.md
|
||||
+1
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-love/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-member-since/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-moderation-actions/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications-category-featured/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications-category-reply/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications-category-staff/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications-digest-daily/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications-digest-hourly/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-notifications/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-offtopic/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-permalink/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-remember-sort/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-respect/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-rich-text-pell/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-rich-text/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-slack-notifications/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-most-liked/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-most-loved/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-most-replied/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-most-respected/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-newest/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-sort-oldest/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-subscriber/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-toxic-comments/README.md
|
||||
@@ -0,0 +1 @@
|
||||
../../../plugins/talk-plugin-viewing-options/README.md
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Plugins Overview
|
||||
permalink: /plugins/
|
||||
toc: true
|
||||
---
|
||||
|
||||
Plugins are the integration point between the Talk core code and custom
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Plugins Directory
|
||||
permalink: /plugins-directory/
|
||||
layout: plugins
|
||||
data: plugins
|
||||
---
|
||||
|
||||
Talk provides a growing ecosystem of plugins that interact with our extensive
|
||||
Server and Client API's. Below you can search for a plugin to use with Talk and
|
||||
discover what their requirements and configuration are.
|
||||
Reference in New Issue
Block a user