3 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
4 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
7 - [Concepts](#concepts)
9 - [Static files](#static-files)
11 - [Server API (only for plugins)](#server-api-only-for-plugins)
12 - [Settings](#settings)
14 - [Update video constants](#update-video-constants)
15 - [Add custom routes](#add-custom-routes)
16 - [Add external auth methods](#add-external-auth-methods)
17 - [Add new transcoding profiles](#add-new-transcoding-profiles)
18 - [Server helpers](#server-helpers)
19 - [Client API (themes & plugins)](#client-api-themes--plugins)
20 - [Plugin static route](#plugin-static-route)
21 - [Notifier](#notifier)
22 - [Markdown Renderer](#markdown-renderer)
23 - [Auth header](#auth-header)
24 - [Plugin router route](#plugin-router-route)
25 - [Custom Modal](#custom-modal)
26 - [Translate](#translate)
27 - [Get public settings](#get-public-settings)
28 - [Get server config](#get-server-config)
29 - [Add custom fields to video form](#add-custom-fields-to-video-form)
30 - [Register settings script](#register-settings-script)
31 - [HTML placeholder elements](#html-placeholder-elements)
32 - [Add/remove left menu links](#addremove-left-menu-links)
33 - [Publishing](#publishing)
34 - [Write a plugin/theme](#write-a-plugintheme)
35 - [Clone the quickstart repository](#clone-the-quickstart-repository)
36 - [Configure your repository](#configure-your-repository)
37 - [Update README](#update-readme)
38 - [Update package.json](#update-packagejson)
39 - [Write code](#write-code)
40 - [Add translations](#add-translations)
41 - [Build your plugin](#build-your-plugin)
42 - [Test your plugin/theme](#test-your-plugintheme)
44 - [Unpublish](#unpublish)
45 - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api)
47 - [Compatibility with PeerTube](#compatibility-with-peertube)
48 - [Spam/moderation plugin](#spammoderation-plugin)
49 - [Other plugin examples](#other-plugin-examples)
51 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
55 Themes are exactly the same as plugins, except that:
56 * Their name starts with `peertube-theme-` instead of `peertube-plugin-`
57 * They cannot declare server code (so they cannot register server hooks or settings)
58 * CSS files are loaded by client only if the theme is chosen by the administrator or the user
62 A plugin registers functions in JavaScript to execute when PeerTube (server and client) fires events. There are 3 types of hooks:
63 * `filter`: used to filter functions parameters or return values.
64 For example to replace words in video comments, or change the videos list behaviour
65 * `action`: used to do something after a certain trigger. For example to send a hook every time a video is published
66 * `static`: same than `action` but PeerTube waits their execution
68 On server side, these hooks are registered by the `library` file defined in `package.json`.
73 "library": "./main.js",
78 And `main.js` defines a `register` function:
83 async function register ({
100 unregisterExternalAuth,
101 registerIdAndPassAuth,
102 unregisterIdAndPassAuth
105 target: 'action:application.listening',
106 handler: () => displayHelloWorld()
112 On client side, these hooks are registered by the `clientScripts` files defined in `package.json`.
113 All client scripts have scopes so PeerTube client only loads scripts it needs:
120 "script": "client/common-client-plugin.js",
121 "scopes": [ "common" ]
124 "script": "client/video-watch-client-plugin.js",
125 "scopes": [ "video-watch" ]
132 And these scripts also define a `register` function:
135 function register ({ registerHook, peertubeHelpers }) {
137 target: 'action:application.init',
138 handler: () => onApplicationInit(peertubeHelpers)
145 Plugins can declare static directories that PeerTube will serve (images for example)
146 from `/plugins/{plugin-name}/{plugin-version}/static/`
147 or `/themes/{theme-name}/{theme-version}/static/` routes.
151 Plugins can declare CSS files that PeerTube will automatically inject in the client.
152 If you need to override existing style, you can use the `#custom-css` selector:
159 #custom-css .header {
160 background-color: red;
164 ### Server API (only for plugins)
168 Plugins can register settings, that PeerTube will inject in the administration interface.
169 The following fields will be automatically translated using the plugin translation files: `label`, `html`, `descriptionHTML`, `options.label`.
170 **These fields are injected in the plugin settings page as HTML, so pay attention to your translation files.**
175 function register (...) {
181 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
184 descriptionHTML: 'The purpose of this field is...',
186 default: 'my super name',
188 // If the setting is not private, anyone can view its value (client code included)
189 // If the setting is private, only server-side hooks can access it
193 const adminName = await settingsManager.getSetting('admin-name')
195 const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ])
198 settingsManager.onSettingsChange(settings => {
199 settings['admin-name])
206 Plugins can store/load JSON data, that PeerTube will store in its database (so don't put files in there).
214 const value = await storageManager.getData('mykey')
215 await storageManager.storeData('mykey', { subkey: 'value' })
219 You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**.
220 This directory and its content won't be deleted when your plugin is uninstalled/upgraded.
227 const basePath = peertubeHelpers.plugin.getDataDirectoryPath()
229 fs.writeFile(path.join(basePath, 'filename.txt'), 'content of my file', function (err) {
235 #### Update video constants
237 You can add/delete video categories, licences or languages using the appropriate managers:
240 function register (...) {
241 videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
242 videoLanguageManager.deleteLanguage('fr')
244 videoCategoryManager.addCategory(42, 'Best category')
245 videoCategoryManager.deleteCategory(1) // Music
247 videoLicenceManager.addLicence(42, 'Best licence')
248 videoLicenceManager.deleteLicence(7) // Public domain
250 videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy
251 playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy
255 #### Add custom routes
257 You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin:
263 const router = getRouter()
264 router.get('/ping', (req, res) => res.json({ message: 'pong' }))
266 // Users are automatically authenticated
267 router.get('/auth', async (res, res) => {
268 const user = await peertubeHelpers.user.getAuthUser(res)
270 const isAdmin = user.role === 0
271 const isModerator = user.role === 1
272 const isUser = user.role === 2
275 username: user.username,
284 The `ping` route can be accessed using:
285 * `/plugins/:pluginName/:pluginVersion/router/ping`
286 * Or `/plugins/:pluginName/router/ping`
289 #### Add external auth methods
291 If you want to add a classic username/email and password auth method (like [LDAP](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-ldap) for example):
294 function register (...) {
296 registerIdAndPassAuth({
297 authName: 'my-auth-method',
299 // PeerTube will try all id and pass plugins in the weight DESC order
300 // Exposing this value in the plugin settings could be interesting
303 // Optional function called by PeerTube when the user clicked on the logout button
305 console.log('User %s logged out.', user.username')
308 // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
309 hookTokenValidity: ({ token, type }) => {
310 if (type === 'access') return { valid: true }
311 if (type === 'refresh') return { valid: false }
314 // Used by PeerTube when the user tries to authenticate
315 login: ({ id, password }) => {
316 if (id === 'user' && password === 'super password') {
319 email: 'user@example.com'
321 displayName: 'User display name'
330 // Unregister this auth method
331 unregisterIdAndPassAuth('my-auth-method')
335 You can also add an external auth method (like [OpenID](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-openid-connect), [SAML2](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-saml2) etc):
338 function register (...) {
340 // result contains the userAuthenticated auth method you can call to authenticate a user
341 const result = registerExternalAuth({
342 authName: 'my-auth-method',
344 // Will be displayed in a button next to the login form
345 authDisplayName: () => 'Auth method'
347 // If the user click on the auth button, PeerTube will forward the request in this function
348 onAuthRequest: (req, res) => {
349 res.redirect('https://external-auth.example.com/auth')
352 // Same than registerIdAndPassAuth option
355 // Same than registerIdAndPassAuth option
356 // hookTokenValidity: ...
359 router.use('/external-auth-callback', (req, res) => {
360 // Forward the request to PeerTube
361 result.userAuthenticated({
365 email: 'user@example.com'
367 displayName: 'User display name'
371 // Unregister this external auth method
372 unregisterExternalAuth('my-auth-method)
376 #### Add new transcoding profiles
378 Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
379 A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
382 async function register ({
386 // Adapt bitrate when using libx264 encoder
388 const builder = (options) => {
389 const { input, resolution, fps, streamNum } = options
391 const streamString = streamNum ? ':' + streamNum : ''
393 // You can also return a promise
394 // All these options are optional
397 // Used to define an alternative scale filter, needed by some encoders
398 // Default to 'scale'
405 // Use a custom bitrate
406 '-b' + streamString + ' 10K'
411 const encoder = 'libx264'
412 const profileName = 'low-quality'
414 // Support this profile for VOD transcoding
415 transcodingManager.addVODProfile(encoder, profileName, builder)
417 // And/Or support this profile for live transcoding
418 transcodingManager.addLiveProfile(encoder, profileName, builder)
422 const builder = (options) => {
423 const { streamNum } = options
425 const streamString = streamNum ? ':' + streamNum : ''
427 // Always copy stream when PeerTube use libfdk_aac or aac encoders
433 const profileName = 'copy-audio'
435 for (const encoder of [ 'libfdk_aac', 'aac' ]) {
436 transcodingManager.addVODProfile(encoder, profileName, builder)
441 PeerTube will try different encoders depending on their priority.
442 If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
443 Plugins can change the order of these encoders and add their custom encoders:
446 async function register ({
450 // Adapt bitrate when using libx264 encoder
452 const builder = () => {
459 // Support libopus and libvpx-vp9 encoders (these codecs could be incompatible with the player)
460 transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
462 // Default priorities are ~100
463 // Lowest priority = 1
464 transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
466 transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
467 transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
469 transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
470 transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
474 During live transcode input options are applied once for each target resolution.
475 Plugins are responsible for detecting such situation and applying input options only once if necessary.
479 PeerTube provides your plugin some helpers. For example:
482 async function register ({
487 const serverActor = await peertubeHelpers.server.getServerActor()
489 await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' })
494 const video = await peertubeHelpers.videos.loadByUrl('...')
499 See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list.
501 ### Client API (themes & plugins)
503 #### Plugin static route
505 To get your plugin static route:
508 function register (...) {
509 const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
510 const imageUrl = baseStaticUrl + '/images/chocobo.png'
516 To notify the user with the PeerTube ToastModule:
519 function register (...) {
520 const { notifier } = peertubeHelpers
521 notifier.success('Success message content.')
522 notifier.error('Error message content.')
526 #### Markdown Renderer
528 To render a formatted markdown text to HTML:
531 function register (...) {
532 const { markdownRenderer } = peertubeHelpers
534 await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
535 // return <strong>My Bold Text</strong>
537 await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)')
538 // return <img alt=alt-img src=http://.../my-image.jpg />
546 To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers:
549 function register (...) {
551 target: 'action:auth-user.information-loaded',
552 handler: ({ user }) => {
554 // Useless because we have the same info in the ({ user }) parameter
555 // It's just an example
556 fetch('/api/v1/users/me', {
558 headers: peertubeHelpers.getAuthHeader()
559 }).then(res => res.json())
560 .then(data => console.log('Hi %s.', data.username))
566 #### Plugin router route
570 To get your plugin router route, you can use `peertubeHelpers.getBaseRouterRoute()`:
573 function register (...) {
575 target: 'action:video-watch.video.loaded',
576 handler: ({ video }) => {
577 fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', {
579 headers: peertubeHelpers.getAuthHeader()
580 }).then(res => res.json())
581 .then(data => console.log('Hi %s.', data))
589 To show a custom modal:
592 function register (...) {
593 peertubeHelpers.showModal({
594 title: 'My custom modal title',
595 content: '<p>My custom modal content</p>',
596 // Optionals parameters :
599 // show cancel button and call action() after hiding modal
600 cancel: { value: 'cancel', action: () => {} },
601 // show confirm button and call action() after hiding modal
602 confirm: { value: 'confirm', action: () => {} },
609 You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):
612 function register (...) {
613 peertubeHelpers.translate('User name')
614 .then(translation => console.log('Translated User name by ' + translation))
618 #### Get public settings
620 To get your public plugin settings:
623 function register (...) {
624 peertubeHelpers.getSettings()
626 if (!s || !s['site-id'] || !s['url']) {
627 console.error('Matomo settings are not set.')
636 #### Get server config
639 function register (...) {
640 peertubeHelpers.getServerConfig()
642 console.log('Fetched server config.', config)
647 #### Add custom fields to video form
649 To add custom fields in the video form (in *Plugin settings* tab):
652 async function register ({ registerVideoField, peertubeHelpers }) {
653 const descriptionHTML = await peertubeHelpers.translate(descriptionSource)
654 const commonOptions = {
655 name: 'my-field-name,
656 label: 'My added field',
657 descriptionHTML: 'Optional description',
658 type: 'input-textarea',
660 // Optional, to hide a field depending on the current form state
661 // liveVideo is in the options object when the user is creating/updating a live
662 // videoToUpdate is in the options object when the user is updating a video
663 hidden: ({ formValues, videoToUpdate, liveVideo }) => {
664 return formValues.pluginData['other-field'] === 'toto'
668 for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) {
669 registerVideoField(commonOptions, { type })
674 PeerTube will send this field value in `body.pluginData['my-field-name']` and fetch it from `video.pluginData['my-field-name']`.
676 So for example, if you want to store an additional metadata for videos, register the following hooks in **server**:
679 async function register ({
683 const fieldName = 'my-field-name'
685 // Store data associated to this video
687 target: 'action:api.video.updated',
688 handler: ({ video, body }) => {
689 if (!body.pluginData) return
691 const value = body.pluginData[fieldName]
694 storageManager.storeData(fieldName + '-' + video.id, value)
698 // Add your custom value to the video, so the client autofill your field using the previously stored value
700 target: 'filter:api.video.get.result',
701 handler: async (video) => {
702 if (!video) return video
703 if (!video.pluginData) video.pluginData = {}
705 const result = await storageManager.getData(fieldName + '-' + video.id)
706 video.pluginData[fieldName] = result
714 #### Register settings script
716 To hide some fields in your settings plugin page depending on the form state:
719 async function register ({ registerSettingsScript }) {
720 registerSettingsScript({
721 isSettingHidden: options => {
722 if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') {
732 #### HTML placeholder elements
734 PeerTube provides some HTML id so plugins can easily insert their own element:
737 async function register (...) {
738 const elem = document.createElement('div')
739 elem.className = 'hello-world-h4'
740 elem.innerHTML = '<h4>Hello everybody! This is an element next to the player</h4>'
742 document.getElementById('plugin-placeholder-player-next').appendChild(elem)
746 See the complete list on https://docs.joinpeertube.org/api-plugins
748 #### Add/remove left menu links
750 Left menu links can be filtered (add/remove a section or add/remove links) using the `filter:left-menu.links.create.result` client hook.
755 PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes take into account your plugin (after ~ 1 day). An official plugin index is available on [packages.joinpeertube.org](https://packages.joinpeertube.org/api/v1/plugins), with no interface to present packages.
757 > The official plugin index source code is available at https://framagit.org/framasoft/peertube/plugin-index
759 ## Write a plugin/theme
762 * Find a name for your plugin or your theme (must not have spaces, it can only contain lowercase letters and `-`)
763 * Add the appropriate prefix:
764 * If you develop a plugin, add `peertube-plugin-` prefix to your plugin name (for example: `peertube-plugin-mysupername`)
765 * If you develop a theme, add `peertube-theme-` prefix to your theme name (for example: `peertube-theme-mysupertheme`)
766 * Clone the quickstart repository
767 * Configure your repository
769 * Update `package.json`
770 * Register hooks, add CSS and static files
771 * Test your plugin/theme with a local PeerTube installation
772 * Publish your plugin/theme on NPM
774 ### Clone the quickstart repository
776 If you develop a plugin, clone the `peertube-plugin-quickstart` repository:
779 $ git clone https://framagit.org/framasoft/peertube/peertube-plugin-quickstart.git peertube-plugin-mysupername
782 If you develop a theme, clone the `peertube-theme-quickstart` repository:
785 $ git clone https://framagit.org/framasoft/peertube/peertube-theme-quickstart.git peertube-theme-mysupername
788 ### Configure your repository
790 Set your repository URL:
793 $ cd peertube-plugin-mysupername # or cd peertube-theme-mysupername
794 $ git remote set-url origin https://your-git-repo
799 Update `README.md` file:
805 ### Update package.json
807 Update the `package.json` fields:
808 * `name` (should start with `peertube-plugin-` or `peertube-theme-`)
813 * `engine.peertube` (the PeerTube version compatibility, must be `>=x.y.z` and nothing else)
815 **Caution:** Don't update or remove other keys, or PeerTube will not be able to index/install your plugin.
816 If you don't need static directories, use an empty `object`:
826 And if you don't need CSS or client script files, use an empty `array`:
839 Now you can register hooks or settings, write CSS and add static directories to your plugin or your theme :)
841 **Caution:** It's up to you to check the code you write will be compatible with the PeerTube NodeJS version,
842 and will be supported by web browsers.
843 If you want to write modern JavaScript, please use a transpiler like [Babel](https://babeljs.io/).
847 If you want to translate strings of your plugin (like labels of your registered settings), create a file and add it to `package.json`:
853 "fr": "./languages/fr.json",
854 "pt-BR": "./languages/pt-BR.json"
860 The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts).
862 Translation files are just objects, with the english sentence as the key and the translation as the value.
863 `fr.json` could contain for example:
867 "Hello world": "Hello le monde"
871 ### Build your plugin
873 If you added client scripts, you'll need to build them using webpack.
881 Add/update your files in the `clientFiles` array of `webpack.config.js`:
884 $ $EDITOR ./webpack.config.js
887 Build your client files:
893 You built files are in the `dist/` directory. Check `package.json` to correctly point to them.
896 ### Test your plugin/theme
898 You'll need to have a local PeerTube instance:
899 * Follow the [dev prerequisites](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#prerequisites)
900 (to clone the repository, install dependencies and prepare the database)
901 * Build PeerTube (`--light` to only build the english language):
904 $ npm run build -- --light
913 * Run PeerTube (you can access to your instance on http://localhost:9000):
916 $ NODE_ENV=test npm start
919 * Register the instance via the CLI:
922 $ node ./dist/server/tools/peertube.js auth add -u 'http://localhost:9000' -U 'root' --password 'test'
925 Then, you can install or reinstall your local plugin/theme by running:
928 $ node ./dist/server/tools/peertube.js plugins install --path /your/absolute/plugin-or-theme/path
933 Go in your plugin/theme directory, and run:
939 Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json`
940 and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours.
942 > If you need to force your plugin update on a specific __PeerTube__ instance, you may update the latest available version manually:
944 > UPDATE "plugin" SET "latestVersion" = 'X.X.X' WHERE "plugin"."name" = 'plugin-shortname';
946 > You'll then be able to click the __Update plugin__ button on the plugin list.
950 If for a particular reason you don't want to maintain your plugin/theme anymore
951 you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface:
954 $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme"
957 ## Plugin & Theme hooks/helpers API
959 See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
964 ### Compatibility with PeerTube
966 Unfortunately, we don't have enough resources to provide hook compatibility between minor releases of PeerTube (for example between `1.2.x` and `1.3.x`).
968 * Don't make assumptions and check every parameter you want to use. For example:
972 target: 'filter:api.video.get.result',
974 // We check the parameter exists and the name field exists too, to avoid exceptions
975 if (video && video.name) video.name += ' <3'
981 * Don't try to require parent PeerTube modules, only use `peertubeHelpers`. If you need another helper or a specific hook, please [create an issue](https://github.com/Chocobozzz/PeerTube/issues/new/choose)
982 * Don't use PeerTube dependencies. Use your own :)
984 If your plugin is broken with a new PeerTube release, update your code and the `peertubeEngine` field of your `package.json` field.
985 This way, older PeerTube versions will still use your old plugin, and new PeerTube versions will use your updated plugin.
987 ### Spam/moderation plugin
989 If you want to create an antispam/moderation plugin, you could use the following hooks:
990 * `filter:api.video.upload.accept.result`: to accept or not local uploads
991 * `filter:api.video-thread.create.accept.result`: to accept or not local thread
992 * `filter:api.video-comment-reply.create.accept.result`: to accept or not local replies
993 * `filter:api.video-threads.list.result`: to change/hide the text of threads
994 * `filter:api.video-thread-comments.list.result`: to change/hide the text of replies
995 * `filter:video.auto-blacklist.result`: to automatically blacklist local or remote videos
997 ### Other plugin examples
999 You can take a look to "official" PeerTube plugins if you want to take inspiration from them: https://framagit.org/framasoft/peertube/official-plugins