Quitter le mode Zen
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
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
49
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
`host` and `port` are optional. `debugger_path` must point to the folder where the `MobDebug` `.lua` file is.
0/1090 · 109
50
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Restart Peertube.
0/170 · 17
51
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Start your debugger server.
0/270 · 27
52
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
For Prosody to connect to the debugger, call the API `http://your_instance.tld/plugins/livechat/router/api/restart_prosody?debugger=true`. This call does not need any authentication. It can be done from a command line, for example with `curl http://your_instance.tld/plugins/livechat/router/api/restart_prosody?debugger=true`. You can even configure your debug server to launch this request automatically.
0/4080 · 408
53
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Prosody will then restart, connecting to the debugger.
0/540 · 54
54
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ##
Quick dev environment using Docker
0/340 · 34
55
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
There is a tutorial, in french, on the [Peertube forum](https://framacolibri.org/t/tutoriel-creer-un-environnement-de-developpement-de-plugin-peertube-rapidement-en-utilisant-docker-et-qui-permet-de-tester-la-federation/17631) that explains how to quickly build a dev env using Docker.
0/2850 · 285
56
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
A repo was made out of it, check out [pt-plugin-dev](https://codeberg.org/mose/pt-plugin-dev).
0/940 · 94