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 - [Custom Modal](#custom-modal)
25 - [Translate](#translate)
26 - [Get public settings](#get-public-settings)
27 - [Get server config](#get-server-config)
28 - [Add custom fields to video form](#add-custom-fields-to-video-form)
29 - [Register settings script](#register-settings-script)
30 - [HTML placeholder elements](#html-placeholder-elements)
31 - [Publishing](#publishing)
32 - [Write a plugin/theme](#write-a-plugintheme)
33 - [Clone the quickstart repository](#clone-the-quickstart-repository)
34 - [Configure your repository](#configure-your-repository)
35 - [Update README](#update-readme)
36 - [Update package.json](#update-packagejson)
37 - [Write code](#write-code)
38 - [Add translations](#add-translations)
39 - [Build your plugin](#build-your-plugin)
40 - [Test your plugin/theme](#test-your-plugintheme)
42 - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api)
44 - [Compatibility with PeerTube](#compatibility-with-peertube)
45 - [Spam/moderation plugin](#spammoderation-plugin)
46 - [Other plugin examples](#other-plugin-examples)
48 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
52 Themes are exactly the same as plugins, except that:
53 * Their name starts with `peertube-theme-` instead of `peertube-plugin-`
54 * They cannot declare server code (so they cannot register server hooks or settings)
55 * CSS files are loaded by client only if the theme is chosen by the administrator or the user
59 A plugin registers functions in JavaScript to execute when PeerTube (server and client) fires events. There are 3 types of hooks:
60 * `filter`: used to filter functions parameters or return values.
61 For example to replace words in video comments, or change the videos list behaviour
62 * `action`: used to do something after a certain trigger. For example to send a hook every time a video is published
63 * `static`: same than `action` but PeerTube waits their execution
65 On server side, these hooks are registered by the `library` file defined in `package.json`.
70 "library": "./main.js",
75 And `main.js` defines a `register` function:
80 async function register ({
97 unregisterExternalAuth,
98 registerIdAndPassAuth,
99 unregisterIdAndPassAuth
102 target: 'action:application.listening',
103 handler: () => displayHelloWorld()
109 On client side, these hooks are registered by the `clientScripts` files defined in `package.json`.
110 All client scripts have scopes so PeerTube client only loads scripts it needs:
117 "script": "client/common-client-plugin.js",
118 "scopes": [ "common" ]
121 "script": "client/video-watch-client-plugin.js",
122 "scopes": [ "video-watch" ]
129 And these scripts also define a `register` function:
132 function register ({ registerHook, peertubeHelpers }) {
134 target: 'action:application.init',
135 handler: () => onApplicationInit(peertubeHelpers)
142 Plugins can declare static directories that PeerTube will serve (images for example)
143 from `/plugins/{plugin-name}/{plugin-version}/static/`
144 or `/themes/{theme-name}/{theme-version}/static/` routes.
148 Plugins can declare CSS files that PeerTube will automatically inject in the client.
149 If you need to override existing style, you can use the `#custom-css` selector:
156 #custom-css .header {
157 background-color: red;
161 ### Server API (only for plugins)
165 Plugins can register settings, that PeerTube will inject in the administration interface.
166 The following fields will be automatically translated using the plugin translation files: `label`, `html`, `descriptionHTML`, `options.label`.
167 **These fields are injected in the plugin settings page as HTML, so pay attention to your translation files.**
172 function register (...) {
178 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
181 descriptionHTML: 'The purpose of this field is...',
183 default: 'my super name',
185 // If the setting is not private, anyone can view its value (client code included)
186 // If the setting is private, only server-side hooks can access it
190 const adminName = await settingsManager.getSetting('admin-name')
192 const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ])
195 settingsManager.onSettingsChange(settings => {
196 settings['admin-name])
203 Plugins can store/load JSON data, that PeerTube will store in its database (so don't put files in there).
211 const value = await storageManager.getData('mykey')
212 await storageManager.storeData('mykey', { subkey: 'value' })
216 You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**.
217 This directory and its content won't be deleted when your plugin is uninstalled/upgraded.
224 const basePath = peertubeHelpers.plugin.getDataDirectoryPath()
226 fs.writeFile(path.join(basePath, 'filename.txt'), 'content of my file', function (err) {
232 #### Update video constants
234 You can add/delete video categories, licences or languages using the appropriate managers:
237 function register (...) {
238 videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
239 videoLanguageManager.deleteLanguage('fr')
241 videoCategoryManager.addCategory(42, 'Best category')
242 videoCategoryManager.deleteCategory(1) // Music
244 videoLicenceManager.addLicence(42, 'Best licence')
245 videoLicenceManager.deleteLicence(7) // Public domain
247 videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy
248 playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy
252 #### Add custom routes
254 You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin:
260 const router = getRouter()
261 router.get('/ping', (req, res) => res.json({ message: 'pong' }))
263 // Users are automatically authenticated
264 router.get('/auth', async (res, res) => {
265 const user = await peertubeHelpers.user.getAuthUser(res)
267 const isAdmin = user.role === 0
268 const isModerator = user.role === 1
269 const isUser = user.role === 2
272 username: user.username,
281 The `ping` route can be accessed using:
282 * `/plugins/:pluginName/:pluginVersion/router/ping`
283 * Or `/plugins/:pluginName/router/ping`
286 #### Add external auth methods
288 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):
291 function register (...) {
293 registerIdAndPassAuth({
294 authName: 'my-auth-method',
296 // PeerTube will try all id and pass plugins in the weight DESC order
297 // Exposing this value in the plugin settings could be interesting
300 // Optional function called by PeerTube when the user clicked on the logout button
302 console.log('User %s logged out.', user.username')
305 // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
306 hookTokenValidity: ({ token, type }) => {
307 if (type === 'access') return { valid: true }
308 if (type === 'refresh') return { valid: false }
311 // Used by PeerTube when the user tries to authenticate
312 login: ({ id, password }) => {
313 if (id === 'user' && password === 'super password') {
316 email: 'user@example.com'
318 displayName: 'User display name'
327 // Unregister this auth method
328 unregisterIdAndPassAuth('my-auth-method')
332 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):
335 function register (...) {
337 // result contains the userAuthenticated auth method you can call to authenticate a user
338 const result = registerExternalAuth({
339 authName: 'my-auth-method',
341 // Will be displayed in a button next to the login form
342 authDisplayName: () => 'Auth method'
344 // If the user click on the auth button, PeerTube will forward the request in this function
345 onAuthRequest: (req, res) => {
346 res.redirect('https://external-auth.example.com/auth')
349 // Same than registerIdAndPassAuth option
352 // Same than registerIdAndPassAuth option
353 // hookTokenValidity: ...
356 router.use('/external-auth-callback', (req, res) => {
357 // Forward the request to PeerTube
358 result.userAuthenticated({
362 email: 'user@example.com'
364 displayName: 'User display name'
368 // Unregister this external auth method
369 unregisterExternalAuth('my-auth-method)
373 #### Add new transcoding profiles
375 Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
376 A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
379 async function register ({
383 // Adapt bitrate when using libx264 encoder
385 const builder = (options) => {
386 const { input, resolution, fps, streamNum } = options
388 const streamString = streamNum ? ':' + streamNum : ''
390 // You can also return a promise
391 // All these options are optional
394 // Used to define an alternative scale filter, needed by some encoders
395 // Default to 'scale'
402 // Use a custom bitrate
403 '-b' + streamString + ' 10K'
408 const encoder = 'libx264'
409 const profileName = 'low-quality'
411 // Support this profile for VOD transcoding
412 transcodingManager.addVODProfile(encoder, profileName, builder)
414 // And/Or support this profile for live transcoding
415 transcodingManager.addLiveProfile(encoder, profileName, builder)
419 const builder = (options) => {
420 const { streamNum } = options
422 const streamString = streamNum ? ':' + streamNum : ''
424 // Always copy stream when PeerTube use libfdk_aac or aac encoders
430 const profileName = 'copy-audio'
432 for (const encoder of [ 'libfdk_aac', 'aac' ]) {
433 transcodingManager.addVODProfile(encoder, profileName, builder)
438 PeerTube will try different encoders depending on their priority.
439 If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
440 Plugins can change the order of these encoders and add their custom encoders:
443 async function register ({
447 // Adapt bitrate when using libx264 encoder
449 const builder = () => {
456 // Support libopus and libvpx-vp9 encoders (these codecs could be incompatible with the player)
457 transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
459 // Default priorities are ~100
460 // Lowest priority = 1
461 transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
463 transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
464 transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
466 transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
467 transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
471 During live transcode input options are applied once for each target resolution.
472 Plugins are responsible for detecting such situation and applying input options only once if necessary.
476 PeerTube provides your plugin some helpers. For example:
479 async function register ({
484 const serverActor = await peertubeHelpers.server.getServerActor()
486 await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' })
491 const video = await peertubeHelpers.videos.loadByUrl('...')
496 See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list.
498 ### Client API (themes & plugins)
500 #### Plugin static route
502 To get your plugin static route:
505 function register (...) {
506 const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
507 const imageUrl = baseStaticUrl + '/images/chocobo.png'
513 To notify the user with the PeerTube ToastModule:
516 function register (...) {
517 const { notifier } = peertubeHelpers
518 notifier.success('Success message content.')
519 notifier.error('Error message content.')
523 #### Markdown Renderer
525 To render a formatted markdown text to HTML:
528 function register (...) {
529 const { markdownRenderer } = peertubeHelpers
531 await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
532 // return <strong>My Bold Text</strong>
534 await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)')
535 // return <img alt=alt-img src=http://.../my-image.jpg />
543 To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers:
546 function register (...) {
548 target: 'action:auth-user.information-loaded',
549 handler: ({ user }) => {
551 // Useless because we have the same info in the ({ user }) parameter
552 // It's just an example
553 fetch('/api/v1/users/me', {
555 headers: peertubeHelpers.getAuthHeader()
556 }).then(res => res.json())
557 .then(data => console.log('Hi %s.', data.username))
565 To show a custom modal:
568 function register (...) {
569 peertubeHelpers.showModal({
570 title: 'My custom modal title',
571 content: '<p>My custom modal content</p>',
572 // Optionals parameters :
575 // show cancel button and call action() after hiding modal
576 cancel: { value: 'cancel', action: () => {} },
577 // show confirm button and call action() after hiding modal
578 confirm: { value: 'confirm', action: () => {} },
585 You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):
588 function register (...) {
589 peertubeHelpers.translate('User name')
590 .then(translation => console.log('Translated User name by ' + translation))
594 #### Get public settings
596 To get your public plugin settings:
599 function register (...) {
600 peertubeHelpers.getSettings()
602 if (!s || !s['site-id'] || !s['url']) {
603 console.error('Matomo settings are not set.')
612 #### Get server config
615 function register (...) {
616 peertubeHelpers.getServerConfig()
618 console.log('Fetched server config.', config)
623 #### Add custom fields to video form
625 To add custom fields in the video form (in *Plugin settings* tab):
628 async function register ({ registerVideoField, peertubeHelpers }) {
629 const descriptionHTML = await peertubeHelpers.translate(descriptionSource)
630 const commonOptions = {
631 name: 'my-field-name,
632 label: 'My added field',
633 descriptionHTML: 'Optional description',
634 type: 'input-textarea',
636 // Optional, to hide a field depending on the current form state
637 // liveVideo is in the options object when the user is creating/updating a live
638 // videoToUpdate is in the options object when the user is updating a video
639 hidden: ({ formValues, videoToUpdate, liveVideo }) => {
640 return formValues.pluginData['other-field'] === 'toto'
644 for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) {
645 registerVideoField(commonOptions, { type })
650 PeerTube will send this field value in `body.pluginData['my-field-name']` and fetch it from `video.pluginData['my-field-name']`.
652 So for example, if you want to store an additional metadata for videos, register the following hooks in **server**:
655 async function register ({
659 const fieldName = 'my-field-name'
661 // Store data associated to this video
663 target: 'action:api.video.updated',
664 handler: ({ video, body }) => {
665 if (!body.pluginData) return
667 const value = body.pluginData[fieldName]
670 storageManager.storeData(fieldName + '-' + video.id, value)
674 // Add your custom value to the video, so the client autofill your field using the previously stored value
676 target: 'filter:api.video.get.result',
677 handler: async (video) => {
678 if (!video) return video
679 if (!video.pluginData) video.pluginData = {}
681 const result = await storageManager.getData(fieldName + '-' + video.id)
682 video.pluginData[fieldName] = result
690 #### Register settings script
692 To hide some fields in your settings plugin page depending on the form state:
695 async function register ({ registerSettingsScript }) {
696 registerSettingsScript({
697 isSettingHidden: options => {
698 if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') {
708 #### HTML placeholder elements
710 PeerTube provides some HTML id so plugins can easily insert their own element:
713 async function register (...) {
714 const elem = document.createElement('div')
715 elem.className = 'hello-world-h4'
716 elem.innerHTML = '<h4>Hello everybody! This is an element next to the player</h4>'
718 document.getElementById('plugin-placeholder-player-next').appendChild(elem)
722 See the complete list on https://docs.joinpeertube.org/api-plugins
726 PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes
727 take into account your plugin (after ~ 1 day). An official PeerTube index is available on https://packages.joinpeertube.org/ (it's just a REST API, so don't expect a beautiful website).
729 ## Write a plugin/theme
732 * Find a name for your plugin or your theme (must not have spaces, it can only contain lowercase letters and `-`)
733 * Add the appropriate prefix:
734 * If you develop a plugin, add `peertube-plugin-` prefix to your plugin name (for example: `peertube-plugin-mysupername`)
735 * If you develop a theme, add `peertube-theme-` prefix to your theme name (for example: `peertube-theme-mysupertheme`)
736 * Clone the quickstart repository
737 * Configure your repository
739 * Update `package.json`
740 * Register hooks, add CSS and static files
741 * Test your plugin/theme with a local PeerTube installation
742 * Publish your plugin/theme on NPM
744 ### Clone the quickstart repository
746 If you develop a plugin, clone the `peertube-plugin-quickstart` repository:
749 $ git clone https://framagit.org/framasoft/peertube/peertube-plugin-quickstart.git peertube-plugin-mysupername
752 If you develop a theme, clone the `peertube-theme-quickstart` repository:
755 $ git clone https://framagit.org/framasoft/peertube/peertube-theme-quickstart.git peertube-theme-mysupername
758 ### Configure your repository
760 Set your repository URL:
763 $ cd peertube-plugin-mysupername # or cd peertube-theme-mysupername
764 $ git remote set-url origin https://your-git-repo
769 Update `README.md` file:
775 ### Update package.json
777 Update the `package.json` fields:
778 * `name` (should start with `peertube-plugin-` or `peertube-theme-`)
783 * `engine.peertube` (the PeerTube version compatibility, must be `>=x.y.z` and nothing else)
785 **Caution:** Don't update or remove other keys, or PeerTube will not be able to index/install your plugin.
786 If you don't need static directories, use an empty `object`:
796 And if you don't need CSS or client script files, use an empty `array`:
809 Now you can register hooks or settings, write CSS and add static directories to your plugin or your theme :)
811 **Caution:** It's up to you to check the code you write will be compatible with the PeerTube NodeJS version,
812 and will be supported by web browsers.
813 If you want to write modern JavaScript, please use a transpiler like [Babel](https://babeljs.io/).
817 If you want to translate strings of your plugin (like labels of your registered settings), create a file and add it to `package.json`:
823 "fr": "./languages/fr.json",
824 "pt-BR": "./languages/pt-BR.json"
830 The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts).
832 Translation files are just objects, with the english sentence as the key and the translation as the value.
833 `fr.json` could contain for example:
837 "Hello world": "Hello le monde"
841 ### Build your plugin
843 If you added client scripts, you'll need to build them using webpack.
851 Add/update your files in the `clientFiles` array of `webpack.config.js`:
854 $ $EDITOR ./webpack.config.js
857 Build your client files:
863 You built files are in the `dist/` directory. Check `package.json` to correctly point to them.
866 ### Test your plugin/theme
868 You'll need to have a local PeerTube instance:
869 * Follow the [dev prerequisites](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#prerequisites)
870 (to clone the repository, install dependencies and prepare the database)
871 * Build PeerTube (`--light` to only build the english language):
874 $ npm run build -- --light
883 * Run PeerTube (you can access to your instance on http://localhost:9000):
886 $ NODE_ENV=test npm start
889 * Register the instance via the CLI:
892 $ node ./dist/server/tools/peertube.js auth add -u 'http://localhost:9000' -U 'root' --password 'test'
895 Then, you can install or reinstall your local plugin/theme by running:
898 $ node ./dist/server/tools/peertube.js plugins install --path /your/absolute/plugin-or-theme/path
903 Go in your plugin/theme directory, and run:
909 Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json`
910 and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours.
913 ## Plugin & Theme hooks/helpers API
915 See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
920 ### Compatibility with PeerTube
922 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`).
924 * Don't make assumptions and check every parameter you want to use. For example:
928 target: 'filter:api.video.get.result',
930 // We check the parameter exists and the name field exists too, to avoid exceptions
931 if (video && video.name) video.name += ' <3'
937 * 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)
938 * Don't use PeerTube dependencies. Use your own :)
940 If your plugin is broken with a new PeerTube release, update your code and the `peertubeEngine` field of your `package.json` field.
941 This way, older PeerTube versions will still use your old plugin, and new PeerTube versions will use your updated plugin.
943 ### Spam/moderation plugin
945 If you want to create an antispam/moderation plugin, you could use the following hooks:
946 * `filter:api.video.upload.accept.result`: to accept or not local uploads
947 * `filter:api.video-thread.create.accept.result`: to accept or not local thread
948 * `filter:api.video-comment-reply.create.accept.result`: to accept or not local replies
949 * `filter:api.video-threads.list.result`: to change/hide the text of threads
950 * `filter:api.video-thread-comments.list.result`: to change/hide the text of replies
951 * `filter:video.auto-blacklist.result`: to automatically blacklist local or remote videos
953 ### Other plugin examples
955 You can take a look to "official" PeerTube plugins if you want to take inspiration from them: https://framagit.org/framasoft/peertube/official-plugins