Quitter le mode Zen
31
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
For general instructions (developping plugins, building, installation, ...), please refer to the [Peertube documentation](https://docs.joinpeertube.org/contribute-plugins?id=write-a-plugintheme).
0/1950 · 195
diagnostic
Anglais
Before asking for help, please use the diagnostic tool:
<a class="peertube-plugin-livechat-launch-diagnostic">Launch diagnostic</a>
(if this button is not opening a new window, please try to refresh the page).
0/2100 · 210
32
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
You can build the plugin with extra debug features simply by using:
0/670 · 67
34
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
This plugin is [REUSE](https://reuse.software/) compliant: it uses SPDX headers to identify licensing information of its source code. More information on the [REUSE](https://reuse.software/) website. You can use the [reuse](https://reuse.readthedocs.io/en/stable/readme.html#) command line tool to help you update headers. The `npm run lint` command will use the `reuse` command to check compliance. Don't forget to add your copyright information in SPDX headers when you modify some code.
0/4930 · 493
35
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ##
ESBuild vs Typescript
0/210 · 21
chat_terms_description
Anglais
These terms & conditions will be shown to all users when then join chatrooms.
Streamers can also configure terms & conditions for their channels, that will be shown right after these global terms & conditions.
0/2100 · 210
36
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
This plugin uses ESBuild for frontend code generation, as the official `peertube-plugin-quickstart` plugin. ESBuild can handle Typescript, but does not check types (see [ESBuild documentation](https://esbuild.github.io/content-types/#typescript)). That's why we first compile Typescript with the `-noEmit` option, just to check types (`check:client:ts` in package.json file). Then, if everything is okay, we run ESBuild to generate the compiled javascript.
0/4590 · 459
37
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ##
Debug Mode
0/100 · 10
38
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
There is a debug mode for this plugin, that shorten some delay. For example, some log files will rotate every two minutes, instead of once per day. This permit to test more easily certain actions, for which it could normally take hours or days to wait.
0/2540 · 254
39
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
To enable this mode, you juste have to create the `/var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode` file (replacing `/var/www/peertube/storage/` by the correct path on your installation).
0/2140 · 214
40
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
The simple existence of this file is sufficient to trigger the debug mode. To make sure it's taken into account, you can restart your Peertube instance.
0/1530 · 153
41
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
This file can contain some JSON to enable more advanced options. To have a list of existing parameters, check `server/lib/debug.ts`. Restart Peertube after each content modification.
0/1840 · 184
federation_dont_publish_remotely_description
Anglais
By checking this setting, your instance will not publish chat information on the fediverse.
Remote Peertube instances will not be aware that they are chat rooms associated to your videos.<br>
<b>Please note</b>: if you already had chats in progress, it is possible that the information has already been published.
You will have to wait for the next video update before the information is unpublished.
Also, if you disable this setting, you'll have to wait for the videos to be updated before the information are
published again. This update happens among others when a live event resumes or stops.<br>
<b>Please note</b>: this setting only affects the publication of information via the ActivityPub protocol.
It will not prevent a remote application from otherwise detecting the presence of chats, and trying to connect to it.
0/8270 · 827
42
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Don't enable this mode on a production server, neither on a public server. This could cause security issues.
0/1090 · 109
43
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ###
Restart Prosody
0/150 · 15
44
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
When debug mode is enabled, you can restart Prosody using this API call: `http://your_instance.tld/plugins/livechat/router/api/restart_prosody`. This call don't need any authentificaiton. It can be done from a command line, for example using `curl http://your_instance.tld/plugins/livechat/router/api/restart_prosody`.
0/3200 · 320
45
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ###
Prosody debugger
0/160 · 16
46
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
It is possible to connect the Prosody AppImage to a remote debugger using [MobDebug](https://luarocks.org/modules/paulclinger/mobdebug).
0/1360 · 136
47
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
To do so, you have to setup MobDebug in a folder that can be accessed by the `peertube` user. Then, add this in the `debub_mode` file:
0/1350 · 135
48
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Fenced code block (json)
{
"debug_prosody": {
"debugger_path": "/the_path_to_mobdebug/src",
"host": "localhost",
"port": "8172"
}
}
0/1230 · 123