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 constant managers:
241 videoLanguageManager,
242 videoCategoryManager,
245 playlistPrivacyManager
247 videoLanguageManager.addConstant('al_bhed', 'Al Bhed')
248 videoLanguageManager.deleteConstant('fr')
250 videoCategoryManager.addConstant(42, 'Best category')
251 videoCategoryManager.deleteConstant(1) // Music
252 videoCategoryManager.resetConstants() // Reset to initial categories
253 videoCategoryManager.getConstants() // Retrieve all category constants
255 videoLicenceManager.addConstant(42, 'Best licence')
256 videoLicenceManager.deleteConstant(7) // Public domain
258 videoPrivacyManager.deleteConstant(2) // Remove Unlisted video privacy
259 playlistPrivacyManager.deleteConstant(3) // Remove Private video playlist privacy
263 #### Add custom routes
265 You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin:
271 const router = getRouter()
272 router.get('/ping', (req, res) => res.json({ message: 'pong' }))
274 // Users are automatically authenticated
275 router.get('/auth', async (res, res) => {
276 const user = await peertubeHelpers.user.getAuthUser(res)
278 const isAdmin = user.role === 0
279 const isModerator = user.role === 1
280 const isUser = user.role === 2
283 username: user.username,
292 The `ping` route can be accessed using:
293 * `/plugins/:pluginName/:pluginVersion/router/ping`
294 * Or `/plugins/:pluginName/router/ping`
297 #### Add external auth methods
299 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):
302 function register (...) {
304 registerIdAndPassAuth({
305 authName: 'my-auth-method',
307 // PeerTube will try all id and pass plugins in the weight DESC order
308 // Exposing this value in the plugin settings could be interesting
311 // Optional function called by PeerTube when the user clicked on the logout button
313 console.log('User %s logged out.', user.username')
316 // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
317 hookTokenValidity: ({ token, type }) => {
318 if (type === 'access') return { valid: true }
319 if (type === 'refresh') return { valid: false }
322 // Used by PeerTube when the user tries to authenticate
323 login: ({ id, password }) => {
324 if (id === 'user' && password === 'super password') {
327 email: 'user@example.com'
329 displayName: 'User display name'
338 // Unregister this auth method
339 unregisterIdAndPassAuth('my-auth-method')
343 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):
346 function register (...) {
348 // result contains the userAuthenticated auth method you can call to authenticate a user
349 const result = registerExternalAuth({
350 authName: 'my-auth-method',
352 // Will be displayed in a button next to the login form
353 authDisplayName: () => 'Auth method'
355 // If the user click on the auth button, PeerTube will forward the request in this function
356 onAuthRequest: (req, res) => {
357 res.redirect('https://external-auth.example.com/auth')
360 // Same than registerIdAndPassAuth option
363 // Same than registerIdAndPassAuth option
364 // hookTokenValidity: ...
367 router.use('/external-auth-callback', (req, res) => {
368 // Forward the request to PeerTube
369 result.userAuthenticated({
373 email: 'user@example.com'
375 displayName: 'User display name'
379 // Unregister this external auth method
380 unregisterExternalAuth('my-auth-method)
384 #### Add new transcoding profiles
386 Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
387 A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
390 async function register ({
394 // Adapt bitrate when using libx264 encoder
396 const builder = (options) => {
397 const { input, resolution, fps, streamNum } = options
399 const streamString = streamNum ? ':' + streamNum : ''
401 // You can also return a promise
402 // All these options are optional
405 // Used to define an alternative scale filter, needed by some encoders
406 // Default to 'scale'
413 // Use a custom bitrate
414 '-b' + streamString + ' 10K'
419 const encoder = 'libx264'
420 const profileName = 'low-quality'
422 // Support this profile for VOD transcoding
423 transcodingManager.addVODProfile(encoder, profileName, builder)
425 // And/Or support this profile for live transcoding
426 transcodingManager.addLiveProfile(encoder, profileName, builder)
430 const builder = (options) => {
431 const { streamNum } = options
433 const streamString = streamNum ? ':' + streamNum : ''
435 // Always copy stream when PeerTube use libfdk_aac or aac encoders
441 const profileName = 'copy-audio'
443 for (const encoder of [ 'libfdk_aac', 'aac' ]) {
444 transcodingManager.addVODProfile(encoder, profileName, builder)
449 PeerTube will try different encoders depending on their priority.
450 If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
451 Plugins can change the order of these encoders and add their custom encoders:
454 async function register ({
458 // Adapt bitrate when using libx264 encoder
460 const builder = () => {
467 // Support libopus and libvpx-vp9 encoders (these codecs could be incompatible with the player)
468 transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
470 // Default priorities are ~100
471 // Lowest priority = 1
472 transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
474 transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
475 transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
477 transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
478 transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
482 During live transcode input options are applied once for each target resolution.
483 Plugins are responsible for detecting such situation and applying input options only once if necessary.
487 PeerTube provides your plugin some helpers. For example:
490 async function register ({
495 const serverActor = await peertubeHelpers.server.getServerActor()
497 await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' })
502 const video = await peertubeHelpers.videos.loadByUrl('...')
507 See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list.
509 ### Client API (themes & plugins)
511 #### Plugin static route
513 To get your plugin static route:
516 function register (...) {
517 const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
518 const imageUrl = baseStaticUrl + '/images/chocobo.png'
524 To notify the user with the PeerTube ToastModule:
527 function register (...) {
528 const { notifier } = peertubeHelpers
529 notifier.success('Success message content.')
530 notifier.error('Error message content.')
534 #### Markdown Renderer
536 To render a formatted markdown text to HTML:
539 function register (...) {
540 const { markdownRenderer } = peertubeHelpers
542 await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
543 // return <strong>My Bold Text</strong>
545 await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)')
546 // return <img alt=alt-img src=http://.../my-image.jpg />
554 To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers:
557 function register (...) {
559 target: 'action:auth-user.information-loaded',
560 handler: ({ user }) => {
562 // Useless because we have the same info in the ({ user }) parameter
563 // It's just an example
564 fetch('/api/v1/users/me', {
566 headers: peertubeHelpers.getAuthHeader()
567 }).then(res => res.json())
568 .then(data => console.log('Hi %s.', data.username))
574 #### Plugin router route
578 To get your plugin router route, you can use `peertubeHelpers.getBaseRouterRoute()`:
581 function register (...) {
583 target: 'action:video-watch.video.loaded',
584 handler: ({ video }) => {
585 fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', {
587 headers: peertubeHelpers.getAuthHeader()
588 }).then(res => res.json())
589 .then(data => console.log('Hi %s.', data))
597 To show a custom modal:
600 function register (...) {
601 peertubeHelpers.showModal({
602 title: 'My custom modal title',
603 content: '<p>My custom modal content</p>',
604 // Optionals parameters :
607 // show cancel button and call action() after hiding modal
608 cancel: { value: 'cancel', action: () => {} },
609 // show confirm button and call action() after hiding modal
610 confirm: { value: 'confirm', action: () => {} },
617 You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):
620 function register (...) {
621 peertubeHelpers.translate('User name')
622 .then(translation => console.log('Translated User name by ' + translation))
626 #### Get public settings
628 To get your public plugin settings:
631 function register (...) {
632 peertubeHelpers.getSettings()
634 if (!s || !s['site-id'] || !s['url']) {
635 console.error('Matomo settings are not set.')
644 #### Get server config
647 function register (...) {
648 peertubeHelpers.getServerConfig()
650 console.log('Fetched server config.', config)
655 #### Add custom fields to video form
657 To add custom fields in the video form (in *Plugin settings* tab):
660 async function register ({ registerVideoField, peertubeHelpers }) {
661 const descriptionHTML = await peertubeHelpers.translate(descriptionSource)
662 const commonOptions = {
663 name: 'my-field-name,
664 label: 'My added field',
665 descriptionHTML: 'Optional description',
666 type: 'input-textarea',
668 // Optional, to hide a field depending on the current form state
669 // liveVideo is in the options object when the user is creating/updating a live
670 // videoToUpdate is in the options object when the user is updating a video
671 hidden: ({ formValues, videoToUpdate, liveVideo }) => {
672 return formValues.pluginData['other-field'] === 'toto'
676 for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) {
677 registerVideoField(commonOptions, { type })
682 PeerTube will send this field value in `body.pluginData['my-field-name']` and fetch it from `video.pluginData['my-field-name']`.
684 So for example, if you want to store an additional metadata for videos, register the following hooks in **server**:
687 async function register ({
691 const fieldName = 'my-field-name'
693 // Store data associated to this video
695 target: 'action:api.video.updated',
696 handler: ({ video, body }) => {
697 if (!body.pluginData) return
699 const value = body.pluginData[fieldName]
702 storageManager.storeData(fieldName + '-' + video.id, value)
706 // Add your custom value to the video, so the client autofill your field using the previously stored value
708 target: 'filter:api.video.get.result',
709 handler: async (video) => {
710 if (!video) return video
711 if (!video.pluginData) video.pluginData = {}
713 const result = await storageManager.getData(fieldName + '-' + video.id)
714 video.pluginData[fieldName] = result
722 #### Register settings script
724 To hide some fields in your settings plugin page depending on the form state:
727 async function register ({ registerSettingsScript }) {
728 registerSettingsScript({
729 isSettingHidden: options => {
730 if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') {
740 #### HTML placeholder elements
742 PeerTube provides some HTML id so plugins can easily insert their own element:
745 async function register (...) {
746 const elem = document.createElement('div')
747 elem.className = 'hello-world-h4'
748 elem.innerHTML = '<h4>Hello everybody! This is an element next to the player</h4>'
750 document.getElementById('plugin-placeholder-player-next').appendChild(elem)
754 See the complete list on https://docs.joinpeertube.org/api-plugins
756 #### Add/remove left menu links
758 Left menu links can be filtered (add/remove a section or add/remove links) using the `filter:left-menu.links.create.result` client hook.
763 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.
765 > The official plugin index source code is available at https://framagit.org/framasoft/peertube/plugin-index
767 ## Write a plugin/theme
770 * Find a name for your plugin or your theme (must not have spaces, it can only contain lowercase letters and `-`)
771 * Add the appropriate prefix:
772 * If you develop a plugin, add `peertube-plugin-` prefix to your plugin name (for example: `peertube-plugin-mysupername`)
773 * If you develop a theme, add `peertube-theme-` prefix to your theme name (for example: `peertube-theme-mysupertheme`)
774 * Clone the quickstart repository
775 * Configure your repository
777 * Update `package.json`
778 * Register hooks, add CSS and static files
779 * Test your plugin/theme with a local PeerTube installation
780 * Publish your plugin/theme on NPM
782 ### Clone the quickstart repository
784 If you develop a plugin, clone the `peertube-plugin-quickstart` repository:
787 $ git clone https://framagit.org/framasoft/peertube/peertube-plugin-quickstart.git peertube-plugin-mysupername
790 If you develop a theme, clone the `peertube-theme-quickstart` repository:
793 $ git clone https://framagit.org/framasoft/peertube/peertube-theme-quickstart.git peertube-theme-mysupername
796 ### Configure your repository
798 Set your repository URL:
801 $ cd peertube-plugin-mysupername # or cd peertube-theme-mysupername
802 $ git remote set-url origin https://your-git-repo
807 Update `README.md` file:
813 ### Update package.json
815 Update the `package.json` fields:
816 * `name` (should start with `peertube-plugin-` or `peertube-theme-`)
821 * `engine.peertube` (the PeerTube version compatibility, must be `>=x.y.z` and nothing else)
823 **Caution:** Don't update or remove other keys, or PeerTube will not be able to index/install your plugin.
824 If you don't need static directories, use an empty `object`:
834 And if you don't need CSS or client script files, use an empty `array`:
847 Now you can register hooks or settings, write CSS and add static directories to your plugin or your theme :)
849 **Caution:** It's up to you to check the code you write will be compatible with the PeerTube NodeJS version,
850 and will be supported by web browsers.
851 If you want to write modern JavaScript, please use a transpiler like [Babel](https://babeljs.io/).
855 If you want to translate strings of your plugin (like labels of your registered settings), create a file and add it to `package.json`:
861 "fr": "./languages/fr.json",
862 "pt-BR": "./languages/pt-BR.json"
868 The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts).
870 Translation files are just objects, with the english sentence as the key and the translation as the value.
871 `fr.json` could contain for example:
875 "Hello world": "Hello le monde"
879 ### Build your plugin
881 If you added client scripts, you'll need to build them using webpack.
889 Add/update your files in the `clientFiles` array of `webpack.config.js`:
892 $ $EDITOR ./webpack.config.js
895 Build your client files:
901 You built files are in the `dist/` directory. Check `package.json` to correctly point to them.
904 ### Test your plugin/theme
906 You'll need to have a local PeerTube instance:
907 * Follow the [dev prerequisites](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#prerequisites)
908 (to clone the repository, install dependencies and prepare the database)
909 * Build PeerTube (`--light` to only build the english language):
912 $ npm run build -- --light
921 * Run PeerTube (you can access to your instance on http://localhost:9000):
924 $ NODE_ENV=test npm start
927 * Register the instance via the CLI:
930 $ node ./dist/server/tools/peertube.js auth add -u 'http://localhost:9000' -U 'root' --password 'test'
933 Then, you can install or reinstall your local plugin/theme by running:
936 $ node ./dist/server/tools/peertube.js plugins install --path /your/absolute/plugin-or-theme/path
941 Go in your plugin/theme directory, and run:
947 Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json`
948 and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours.
950 > If you need to force your plugin update on a specific __PeerTube__ instance, you may update the latest available version manually:
952 > UPDATE "plugin" SET "latestVersion" = 'X.X.X' WHERE "plugin"."name" = 'plugin-shortname';
954 > You'll then be able to click the __Update plugin__ button on the plugin list.
958 If for a particular reason you don't want to maintain your plugin/theme anymore
959 you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface:
962 $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme"
965 ## Plugin & Theme hooks/helpers API
967 See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
972 ### Compatibility with PeerTube
974 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`).
976 * Don't make assumptions and check every parameter you want to use. For example:
980 target: 'filter:api.video.get.result',
982 // We check the parameter exists and the name field exists too, to avoid exceptions
983 if (video && video.name) video.name += ' <3'
989 * 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)
990 * Don't use PeerTube dependencies. Use your own :)
992 If your plugin is broken with a new PeerTube release, update your code and the `peertubeEngine` field of your `package.json` field.
993 This way, older PeerTube versions will still use your old plugin, and new PeerTube versions will use your updated plugin.
995 ### Spam/moderation plugin
997 If you want to create an antispam/moderation plugin, you could use the following hooks:
998 * `filter:api.video.upload.accept.result`: to accept or not local uploads
999 * `filter:api.video-thread.create.accept.result`: to accept or not local thread
1000 * `filter:api.video-comment-reply.create.accept.result`: to accept or not local replies
1001 * `filter:api.video-threads.list.result`: to change/hide the text of threads
1002 * `filter:api.video-thread-comments.list.result`: to change/hide the text of replies
1003 * `filter:video.auto-blacklist.result`: to automatically blacklist local or remote videos
1005 ### Other plugin examples
1007 You can take a look to "official" PeerTube plugins if you want to take inspiration from them: https://framagit.org/framasoft/peertube/official-plugins