mirror of
https://github.com/wassname/talk.git
synced 2026-07-09 11:12:44 +08:00
immber
4d41d999fb
* added storyURL and storyID * added story scraping section * fixed typo on sso * rebaseing on latest release/4 branch * updated version on slack docs * added Contributing a Translation section to developing * fixing typos * updated v5 config page, reorder list, add toc * added cli sect, fixed contact menu link * updated talk to coral on contact page * added a new v5 auth section * added session length to auth docs * added an admin settings page to v5 * added v5 css section * added a v5 notifications section * updated faq and troubleshooting, moved out of v4 menu * added migrating to v5 and moved migrating section out of v4 * added plugins note to migration pg * fix: linting and extra HTML * change sidebar migrating v5 to v5.0+ Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * downtime being likely is too optimistic, it will be required Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * rewords plugins note on migrating to v5 Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * tag code block as html Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * added link to contributing * rephrased openid connect description * fixed link to contributing * correcting descriptions of email auth behavior Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * Adding link to css classnames Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * renamed new auth to Social and Email Authentication * pulled extra line breaks Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
139 lines
8.1 KiB
Markdown
139 lines
8.1 KiB
Markdown
---
|
||
title: Admin Settings
|
||
permalink: /v5/administration/
|
||
---
|
||
|
||
Upon completing the installation setup wizard, you will be able to login to Coral with the ADMIN user you created during setup.
|
||
|
||
Users who login with the ADMIN role are able to access the Configure tab, and from here change settings that control the functionality of your Coral instance.
|
||
|
||
## General
|
||
|
||
### Language
|
||
You can set the default language Coral uses in **Admin** > **Configure** > **General**.
|
||
|
||
You can see what languages Coral currently supports here: https://github.com/coralproject/talk/tree/master/src/locales
|
||
|
||
### Comment Stream Settings
|
||
|
||
Also located in **Admin** > **Configure** > **General** are the setting to control the comment stream. These settings are site-wide and will affect all of your comment streams.
|
||
|
||
#### **Community guidelines summary**
|
||
This will appear above the comments sitewide. You can format the text using Markdown.
|
||
|
||
#### **Sitewide closed comments message**
|
||
A message that will be displayed when comment streams are closed sitewide.
|
||
|
||
#### **Comment length**
|
||
Set minimum and maximum comment length requirements. Blank spaces at the beginning and the end of a comment will be trimmed. Some newsrooms we’ve worked with prefer a limit between 2000 and 5000
|
||
characters. Commenters will be alerted that they have gone over that number and won’t be able to submit their comment until they’ve edited it. This can be a useful tool to ensure commenters are concise with their comments.
|
||
|
||
#### **Comment editing**
|
||
Set a limit on how long commenters have to edit their comments sitewide. Edited comments are marked as (Edited) on the comment stream and the moderation panel.
|
||
|
||
#### **Closing comment streams**
|
||
Set comment streams to close after a defined period of time after a story’s publication
|
||
|
||
#### **Closed comment stream message**
|
||
A message to appear when a story is closed for commenting.
|
||
|
||
### Reactions
|
||
Coral comes with a `Respect` button out of the box. Why a “Respect” button, you
|
||
ask?
|
||
[Read more here](https://mediaengagement.org/research/engagement-buttons/).
|
||
|
||
You can also create your own custom reaction
|
||
buttons by modifying the Reaction label.
|
||
|
||
### Badges & Staff Member Badge
|
||
|
||
Badges differentiate users on the comment stream. By default, the `Staff` user badge displays when a commenter has an Admin, Moderator, or Staff role.
|
||
|
||
You can customize the badge label used for Staff roles by providing your own custom badge text. *i.e.: "NewsSite Team"*
|
||
|
||
Custom user badges are also available with SSO integrations. See [Single Sign On](/talk/v5/integrating/sso/)
|
||
|
||
|
||
## Moderation
|
||
These options can be found under **Admin** > **Configure** > **Moderation**.
|
||
|
||
### Pre-moderation
|
||
When pre-moderation is turned on, comments will not be published unless approved by a moderator.
|
||
|
||
### Recent History
|
||
Prevents repeat offenders from publishing comments without approval. When a commenter's rejection rate is above the threshold, their comments are sent to the Pending queue for moderation. This does not apply to Staff comments.
|
||
|
||
Rejection rate time period determines the look back period of commenter activity that will be considered in performing the calculation.
|
||
|
||
Rejection rate threshold is calculated by dividing
|
||
number of Rejected comments by (rejected comments + published comments) over the time period specified, and is displayed as a percentage. It does not include comments pending for toxicity, spam or pre-moderation, only moderated comments are considred.
|
||
|
||
### Toxic Comment Filter
|
||
|
||
Using Google's Perspective API, the Toxic Comment Filter warns users when comments exceed the predefined toxicity threshold. You can read more about Google’s Perspective API and/or request an API key here: http://perspectiveapi.com/.
|
||
|
||
Comments with a toxicity score above the threshold will not be published and are placed in the Pending Queue for review by a moderator. Only if approved by a moderator, then the comment will be published.
|
||
|
||
If a comment exceeds the threshold, the commenter is warned that their comment may be toxic, and are given the chance to modify their comment before posting. If the revised comment is below the Toxicity Threshold, it is posted and displayed normally; however if the revised comment still exceeds the Toxicity Threshold, it is not displayed on the stream and instead is sent to the Pending queue for moderation.
|
||
|
||
Perspective API uses machine learning based on existing databases of accepted/rejected comments to guess the probability that a comment is abusive and/or toxic. English is the default language, but experimental models are available in multiple languages. Sites can also work with Jigsaw to create an individualized data set specifically trained on their own comment history. Read more about Coral’s take on toxicity [on our blog](https://coralproject.net/blog/toxic-avenging/).
|
||
|
||
### Spam Detection Filter
|
||
|
||
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 is a premium service, charges may apply.*
|
||
|
||
## Banned & Suspect Words and Phrases
|
||
Located in **Admin** > **Configure** > **Banned words and phrases**.
|
||
|
||
**Banned words** are a list of words or phrases that will trigger a comment to be automatically **Rejected**.
|
||
|
||
Comments containing a word or phrase in the **Suspect Words** List are placed into the **Reported** queue for moderator review and are published (if comments are not pre-moderated).
|
||
|
||
Lists of words/phrases are not case sensitive, and are separated by new lines.
|
||
|
||
|
||
## Email SMTP Settings
|
||
These settings can be found under **Admin** > **Configure** > **Email**.
|
||
|
||
You can configure a **From Name** as well as a **From Email Address** to appear on all outgoing emails.
|
||
|
||
Coral will use your SMTP provider for all outgoing mail including user invites, email verifications, password resets, and notifications. Specify your SMTP provider's settings for Host, Port, and authentication to send emails from Coral.
|
||
|
||
The `Invite` (users) button on the Community tab will only be available if Email settings have been configured.
|
||
|
||
## Advanced
|
||
Located in **Admin** > **Configure** > **Advanced**.
|
||
|
||
### Embed Code
|
||
This is the unique script that is used to embed Coral comment streams on your website. For more information about using your Embed code see [CMS Integration](/talk/v5/integrating/cms/).
|
||
|
||
### Custom CSS
|
||
The link to your custom stylesheet. This will override any default styles, so you can style the comment embed to match your site.
|
||
|
||
### Live Updates
|
||
When enabled, there will be real-time loading and updating of comments via subscriptions
|
||
(specifically GraphQL Subscriptions). When disabled, users will have to refresh the page to see new comments.
|
||
|
||
Coral enables this via “Load More” buttons for both top-level comments (this
|
||
button appears at the top of the stream), and within conversation threads (this
|
||
button appears in situ for replies).
|
||
|
||
We’ve decided to go this route in order to make the viewing experience as smooth
|
||
as possible, so that the feed of comments doesn’t change as you’re reading just
|
||
because new comments are coming in. This could be especially disruptive on
|
||
breaking news and/or controversial stories with very active discussions.
|
||
|
||
This option can be disabled by setting the environment variable: [DISABLE_LIVE_UPDATES](/talk/v5/configuration/#disable-live-updates)
|
||
|
||
|
||
### Permitted Domains
|
||
|
||
List of domains where your Coral instance is allowed to be embedded. List each domain and subdomain in use separately and include the scheme for example: `http://localhost:3000`, `https://staging.yourdomain.com`, `http://yourdomain.com`, `https://yourdomain.com`, etc.
|
||
|
||
### Story Creation Settings
|
||
Advanced settings for how stories are created within Coral; such as if stories are to be automatically created when they are published from your CMS.
|
||
|
||
See CMS Integration secions [Story Creation](/talk/v5/integrating/cms/#story-creation) and [Story Scraping](/talk/v5/integrating/cms/#story-scraping) for more details.
|