From f0fc7148aa2d80d8f5bd7829de1444e730c115b9 Mon Sep 17 00:00:00 2001
From: John Livingston <git@john-livingston.fr>
Date: Mon, 12 Apr 2021 16:31:48 +0200
Subject: [PATCH] Adding an useless settings to display some help.

---
 server/lib/settings.ts | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/server/lib/settings.ts b/server/lib/settings.ts
index 12ea6131..d8c17b23 100644
--- a/server/lib/settings.ts
+++ b/server/lib/settings.ts
@@ -3,6 +3,24 @@ import { getBaseRouter } from './helpers'
 export function initSettings ({
   registerSetting
 }: RegisterServerOptions): void {
+  registerSetting({
+    name: 'chat-read-documentation',
+    label: 'I have read the documentation',
+    type: 'input-checkbox',
+    default: false,
+    private: false, // not private so that I can check when doing support
+    descriptionHTML: 'Please read the ' +
+      '<a href="https://github.com/JohnXLivingston/peertube-plugin-livechat" target="_blank">documentation<a> ' +
+      'before trying to use this plugin.<br>' +
+      'There is 3 way to use it: <ul>' +
+      '<li>By installing the Prosoxy XMPP server package on your server, ' +
+      'and using the «builtin Prosody XMPP Server» feature.</li>' +
+      '<li>By using an existing XMPP server, with anonymous authentication and rooms enabled.</li>' +
+      '<li>By using any external webchat that can be included in an iframe.</li>' +
+      '</ul><br>' +
+      'Before asking for help, please use this diagnostic tool: ' +
+      '<a href="' + getBaseRouter() + 'settings/diagnostic" target="_blank">Launch diagnostic</a>.<br>'
+  })
   registerSetting({
     name: 'chat-auto-display',
     label: 'Automatically open the chat',
@@ -59,9 +77,7 @@ export function initSettings ({
     // /!\ dont auto-activate on existing settups. FIXME: how to do this?
     default: false, // TODO: set to true when peertube has fixed https://github.com/Chocobozzz/PeerTube/issues/3838
     private: false,
-    descriptionHTML: 'If checked, this will use a builtin XMPP server. This is the recommanded setup.<br>' +
-    'TODO: add link to documentation.<br>' +
-    '<a href="' + getBaseRouter() + 'settings/diagnostic" target="_blank">Launch diagnostic</a>.<br>'
+    descriptionHTML: 'If checked, this will use a builtin XMPP server. This is the recommanded setup.'
   })
 
   registerSetting({