From 5ab73a45704a3edbf31493314312ea76a4f510a5 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 17 Aug 2023 15:10:18 +0200 Subject: [PATCH] Improve plugin guide --- support/doc/plugins/guide.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index afc5b9337..81f52cf6c 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -1071,7 +1071,7 @@ You built files are in the `dist/` directory. Check `package.json` to correctly ### Test your plugin/theme -You need to have a running PeerTube instance with an administrator account. +You need to have a local PeerTube instance with an administrator account. If you're using dev server on your local computer, test your plugin on `localhost:9000` using `npm run dev` because plugin CSS is not injected in Angular webserver (`localhost:3000`). Install PeerTube CLI (can be installed on another computer/server than the PeerTube instance): @@ -1086,7 +1086,9 @@ Register the PeerTube instance via the CLI: peertube-cli auth add -u 'https://peertube.example.com' -U 'root' --password 'test' ``` -Then, you can install your local plugin/theme by running: +Then, you can install your local plugin/theme. +The `--path` option is the local path on the PeerTube instance. +If the PeerTube instance is running on another server/computer, you must copy your plugin directory there. ```sh peertube-cli plugins install --path /your/absolute/plugin-or-theme/path