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 - [Unpublish](#unpublish)
43 - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api)
45 - [Compatibility with PeerTube](#compatibility-with-peertube)
46 - [Spam/moderation plugin](#spammoderation-plugin)
47 - [Other plugin examples](#other-plugin-examples)
49 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
53 Themes are exactly the same as plugins, except that:
54 * Their name starts with `peertube-theme-` instead of `peertube-plugin-`
55 * They cannot declare server code (so they cannot register server hooks or settings)
56 * CSS files are loaded by client only if the theme is chosen by the administrator or the user
60 A plugin registers functions in JavaScript to execute when PeerTube (server and client) fires events. There are 3 types of hooks:
61 * `filter`: used to filter functions parameters or return values.
62 For example to replace words in video comments, or change the videos list behaviour
63 * `action`: used to do something after a certain trigger. For example to send a hook every time a video is published
64 * `static`: same than `action` but PeerTube waits their execution
66 On server side, these hooks are registered by the `library` file defined in `package.json`.
71 "library": "./main.js",
76 And `main.js` defines a `register` function:
81 async function register ({
98 unregisterExternalAuth,
99 registerIdAndPassAuth,
100 unregisterIdAndPassAuth
103 target: 'action:application.listening',
104 handler: () => displayHelloWorld()
110 On client side, these hooks are registered by the `clientScripts` files defined in `package.json`.
111 All client scripts have scopes so PeerTube client only loads scripts it needs:
118 "script": "client/common-client-plugin.js",
119 "scopes": [ "common" ]
122 "script": "client/video-watch-client-plugin.js",
123 "scopes": [ "video-watch" ]
130 And these scripts also define a `register` function:
133 function register ({ registerHook, peertubeHelpers }) {
135 target: 'action:application.init',
136 handler: () => onApplicationInit(peertubeHelpers)
143 Plugins can declare static directories that PeerTube will serve (images for example)
144 from `/plugins/{plugin-name}/{plugin-version}/static/`
145 or `/themes/{theme-name}/{theme-version}/static/` routes.
149 Plugins can declare CSS files that PeerTube will automatically inject in the client.
150 If you need to override existing style, you can use the `#custom-css` selector:
157 #custom-css .header {
158 background-color: red;
162 ### Server API (only for plugins)
166 Plugins can register settings, that PeerTube will inject in the administration interface.
167 The following fields will be automatically translated using the plugin translation files: `label`, `html`, `descriptionHTML`, `options.label`.
168 **These fields are injected in the plugin settings page as HTML, so pay attention to your translation files.**
173 function register (...) {
179 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
182 descriptionHTML: 'The purpose of this field is...',
184 default: 'my super name',
186 // If the setting is not private, anyone can view its value (client code included)
187 // If the setting is private, only server-side hooks can access it
191 const adminName = await settingsManager.getSetting('admin-name')
193 const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ])
196 settingsManager.onSettingsChange(settings => {
197 settings['admin-name])
204 Plugins can store/load JSON data, that PeerTube will store in its database (so don't put files in there).
212 const value = await storageManager.getData('mykey')
213 await storageManager.storeData('mykey', { subkey: 'value' })
217 You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**.
218 This directory and its content won't be deleted when your plugin is uninstalled/upgraded.
225 const basePath = peertubeHelpers.plugin.getDataDirectoryPath()
227 fs.writeFile(path.join(basePath, 'filename.txt'), 'content of my file', function (err) {
233 #### Update video constants
235 You can add/delete video categories, licences or languages using the appropriate managers:
238 function register (...) {
239 videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
240 videoLanguageManager.deleteLanguage('fr')
242 videoCategoryManager.addCategory(42, 'Best category')
243 videoCategoryManager.deleteCategory(1) // Music
245 videoLicenceManager.addLicence(42, 'Best licence')
246 videoLicenceManager.deleteLicence(7) // Public domain
248 videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy
249 playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy
253 #### Add custom routes
255 You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin:
261 const router = getRouter()
262 router.get('/ping', (req, res) => res.json({ message: 'pong' }))
264 // Users are automatically authenticated
265 router.get('/auth', async (res, res) => {
266 const user = await peertubeHelpers.user.getAuthUser(res)
268 const isAdmin = user.role === 0
269 const isModerator = user.role === 1
270 const isUser = user.role === 2
273 username: user.username,
282 The `ping` route can be accessed using:
283 * `/plugins/:pluginName/:pluginVersion/router/ping`
284 * Or `/plugins/:pluginName/router/ping`
287 #### Add external auth methods
289 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):
292 function register (...) {
294 registerIdAndPassAuth({
295 authName: 'my-auth-method',
297 // PeerTube will try all id and pass plugins in the weight DESC order
298 // Exposing this value in the plugin settings could be interesting
301 // Optional function called by PeerTube when the user clicked on the logout button
303 console.log('User %s logged out.', user.username')
306 // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
307 hookTokenValidity: ({ token, type }) => {
308 if (type === 'access') return { valid: true }
309 if (type === 'refresh') return { valid: false }
312 // Used by PeerTube when the user tries to authenticate
313 login: ({ id, password }) => {
314 if (id === 'user' && password === 'super password') {
317 email: 'user@example.com'
319 displayName: 'User display name'
328 // Unregister this auth method
329 unregisterIdAndPassAuth('my-auth-method')
333 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):
336 function register (...) {
338 // result contains the userAuthenticated auth method you can call to authenticate a user
339 const result = registerExternalAuth({
340 authName: 'my-auth-method',
342 // Will be displayed in a button next to the login form
343 authDisplayName: () => 'Auth method'
345 // If the user click on the auth button, PeerTube will forward the request in this function
346 onAuthRequest: (req, res) => {
347 res.redirect('https://external-auth.example.com/auth')
350 // Same than registerIdAndPassAuth option
353 // Same than registerIdAndPassAuth option
354 // hookTokenValidity: ...
357 router.use('/external-auth-callback', (req, res) => {
358 // Forward the request to PeerTube
359 result.userAuthenticated({
363 email: 'user@example.com'
365 displayName: 'User display name'
369 // Unregister this external auth method
370 unregisterExternalAuth('my-auth-method)
374 #### Add new transcoding profiles
376 Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
377 A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
380 async function register ({
384 // Adapt bitrate when using libx264 encoder
386 const builder = (options) => {
387 const { input, resolution, fps, streamNum } = options
389 const streamString = streamNum ? ':' + streamNum : ''
391 // You can also return a promise
392 // All these options are optional
395 // Used to define an alternative scale filter, needed by some encoders
396 // Default to 'scale'
403 // Use a custom bitrate
404 '-b' + streamString + ' 10K'
409 const encoder = 'libx264'
410 const profileName = 'low-quality'
412 // Support this profile for VOD transcoding
413 transcodingManager.addVODProfile(encoder, profileName, builder)
415 // And/Or support this profile for live transcoding
416 transcodingManager.addLiveProfile(encoder, profileName, builder)
420 const builder = (options) => {
421 const { streamNum } = options
423 const streamString = streamNum ? ':' + streamNum : ''
425 // Always copy stream when PeerTube use libfdk_aac or aac encoders
431 const profileName = 'copy-audio'
433 for (const encoder of [ 'libfdk_aac', 'aac' ]) {
434 transcodingManager.addVODProfile(encoder, profileName, builder)
439 PeerTube will try different encoders depending on their priority.
440 If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
441 Plugins can change the order of these encoders and add their custom encoders:
444 async function register ({
448 // Adapt bitrate when using libx264 encoder
450 const builder = () => {
457 // Support libopus and libvpx-vp9 encoders (these codecs could be incompatible with the player)
458 transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
460 // Default priorities are ~100
461 // Lowest priority = 1
462 transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
464 transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
465 transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
467 transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
468 transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
472 During live transcode input options are applied once for each target resolution.
473 Plugins are responsible for detecting such situation and applying input options only once if necessary.
477 PeerTube provides your plugin some helpers. For example:
480 async function register ({
485 const serverActor = await peertubeHelpers.server.getServerActor()
487 await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' })
492 const video = await peertubeHelpers.videos.loadByUrl('...')
497 See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list.
499 ### Client API (themes & plugins)
501 #### Plugin static route
503 To get your plugin static route:
506 function register (...) {
507 const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
508 const imageUrl = baseStaticUrl + '/images/chocobo.png'
514 To notify the user with the PeerTube ToastModule:
517 function register (...) {
518 const { notifier } = peertubeHelpers
519 notifier.success('Success message content.')
520 notifier.error('Error message content.')
524 #### Markdown Renderer
526 To render a formatted markdown text to HTML:
529 function register (...) {
530 const { markdownRenderer } = peertubeHelpers
532 await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
533 // return <strong>My Bold Text</strong>
535 await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)')
536 // return <img alt=alt-img src=http://.../my-image.jpg />
544 To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers:
547 function register (...) {
549 target: 'action:auth-user.information-loaded',
550 handler: ({ user }) => {
552 // Useless because we have the same info in the ({ user }) parameter
553 // It's just an example
554 fetch('/api/v1/users/me', {
556 headers: peertubeHelpers.getAuthHeader()
557 }).then(res => res.json())
558 .then(data => console.log('Hi %s.', data.username))
566 To show a custom modal:
569 function register (...) {
570 peertubeHelpers.showModal({
571 title: 'My custom modal title',
572 content: '<p>My custom modal content</p>',
573 // Optionals parameters :
576 // show cancel button and call action() after hiding modal
577 cancel: { value: 'cancel', action: () => {} },
578 // show confirm button and call action() after hiding modal
579 confirm: { value: 'confirm', action: () => {} },
586 You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):
589 function register (...) {
590 peertubeHelpers.translate('User name')
591 .then(translation => console.log('Translated User name by ' + translation))
595 #### Get public settings
597 To get your public plugin settings:
600 function register (...) {
601 peertubeHelpers.getSettings()
603 if (!s || !s['site-id'] || !s['url']) {
604 console.error('Matomo settings are not set.')
613 #### Get server config
616 function register (...) {
617 peertubeHelpers.getServerConfig()
619 console.log('Fetched server config.', config)
624 #### Add custom fields to video form
626 To add custom fields in the video form (in *Plugin settings* tab):
629 async function register ({ registerVideoField, peertubeHelpers }) {
630 const descriptionHTML = await peertubeHelpers.translate(descriptionSource)
631 const commonOptions = {
632 name: 'my-field-name,
633 label: 'My added field',
634 descriptionHTML: 'Optional description',
635 type: 'input-textarea',
637 // Optional, to hide a field depending on the current form state
638 // liveVideo is in the options object when the user is creating/updating a live
639 // videoToUpdate is in the options object when the user is updating a video
640 hidden: ({ formValues, videoToUpdate, liveVideo }) => {
641 return formValues.pluginData['other-field'] === 'toto'
645 for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) {
646 registerVideoField(commonOptions, { type })
651 PeerTube will send this field value in `body.pluginData['my-field-name']` and fetch it from `video.pluginData['my-field-name']`.
653 So for example, if you want to store an additional metadata for videos, register the following hooks in **server**:
656 async function register ({
660 const fieldName = 'my-field-name'
662 // Store data associated to this video
664 target: 'action:api.video.updated',
665 handler: ({ video, body }) => {
666 if (!body.pluginData) return
668 const value = body.pluginData[fieldName]
671 storageManager.storeData(fieldName + '-' + video.id, value)
675 // Add your custom value to the video, so the client autofill your field using the previously stored value
677 target: 'filter:api.video.get.result',
678 handler: async (video) => {
679 if (!video) return video
680 if (!video.pluginData) video.pluginData = {}
682 const result = await storageManager.getData(fieldName + '-' + video.id)
683 video.pluginData[fieldName] = result
691 #### Register settings script
693 To hide some fields in your settings plugin page depending on the form state:
696 async function register ({ registerSettingsScript }) {
697 registerSettingsScript({
698 isSettingHidden: options => {
699 if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') {
709 #### HTML placeholder elements
711 PeerTube provides some HTML id so plugins can easily insert their own element:
714 async function register (...) {
715 const elem = document.createElement('div')
716 elem.className = 'hello-world-h4'
717 elem.innerHTML = '<h4>Hello everybody! This is an element next to the player</h4>'
719 document.getElementById('plugin-placeholder-player-next').appendChild(elem)
723 See the complete list on https://docs.joinpeertube.org/api-plugins
727 PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes
728 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).
730 ## Write a plugin/theme
733 * Find a name for your plugin or your theme (must not have spaces, it can only contain lowercase letters and `-`)
734 * Add the appropriate prefix:
735 * If you develop a plugin, add `peertube-plugin-` prefix to your plugin name (for example: `peertube-plugin-mysupername`)
736 * If you develop a theme, add `peertube-theme-` prefix to your theme name (for example: `peertube-theme-mysupertheme`)
737 * Clone the quickstart repository
738 * Configure your repository
740 * Update `package.json`
741 * Register hooks, add CSS and static files
742 * Test your plugin/theme with a local PeerTube installation
743 * Publish your plugin/theme on NPM
745 ### Clone the quickstart repository
747 If you develop a plugin, clone the `peertube-plugin-quickstart` repository:
750 $ git clone https://framagit.org/framasoft/peertube/peertube-plugin-quickstart.git peertube-plugin-mysupername
753 If you develop a theme, clone the `peertube-theme-quickstart` repository:
756 $ git clone https://framagit.org/framasoft/peertube/peertube-theme-quickstart.git peertube-theme-mysupername
759 ### Configure your repository
761 Set your repository URL:
764 $ cd peertube-plugin-mysupername # or cd peertube-theme-mysupername
765 $ git remote set-url origin https://your-git-repo
770 Update `README.md` file:
776 ### Update package.json
778 Update the `package.json` fields:
779 * `name` (should start with `peertube-plugin-` or `peertube-theme-`)
784 * `engine.peertube` (the PeerTube version compatibility, must be `>=x.y.z` and nothing else)
786 **Caution:** Don't update or remove other keys, or PeerTube will not be able to index/install your plugin.
787 If you don't need static directories, use an empty `object`:
797 And if you don't need CSS or client script files, use an empty `array`:
810 Now you can register hooks or settings, write CSS and add static directories to your plugin or your theme :)
812 **Caution:** It's up to you to check the code you write will be compatible with the PeerTube NodeJS version,
813 and will be supported by web browsers.
814 If you want to write modern JavaScript, please use a transpiler like [Babel](https://babeljs.io/).
818 If you want to translate strings of your plugin (like labels of your registered settings), create a file and add it to `package.json`:
824 "fr": "./languages/fr.json",
825 "pt-BR": "./languages/pt-BR.json"
831 The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts).
833 Translation files are just objects, with the english sentence as the key and the translation as the value.
834 `fr.json` could contain for example:
838 "Hello world": "Hello le monde"
842 ### Build your plugin
844 If you added client scripts, you'll need to build them using webpack.
852 Add/update your files in the `clientFiles` array of `webpack.config.js`:
855 $ $EDITOR ./webpack.config.js
858 Build your client files:
864 You built files are in the `dist/` directory. Check `package.json` to correctly point to them.
867 ### Test your plugin/theme
869 You'll need to have a local PeerTube instance:
870 * Follow the [dev prerequisites](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#prerequisites)
871 (to clone the repository, install dependencies and prepare the database)
872 * Build PeerTube (`--light` to only build the english language):
875 $ npm run build -- --light
884 * Run PeerTube (you can access to your instance on http://localhost:9000):
887 $ NODE_ENV=test npm start
890 * Register the instance via the CLI:
893 $ node ./dist/server/tools/peertube.js auth add -u 'http://localhost:9000' -U 'root' --password 'test'
896 Then, you can install or reinstall your local plugin/theme by running:
899 $ node ./dist/server/tools/peertube.js plugins install --path /your/absolute/plugin-or-theme/path
904 Go in your plugin/theme directory, and run:
910 Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json`
911 and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours.
915 If for a particular reason you don't want to maintain your plugin/theme anymore
916 you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface:
919 $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme"
922 ## Plugin & Theme hooks/helpers API
924 See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
929 ### Compatibility with PeerTube
931 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`).
933 * Don't make assumptions and check every parameter you want to use. For example:
937 target: 'filter:api.video.get.result',
939 // We check the parameter exists and the name field exists too, to avoid exceptions
940 if (video && video.name) video.name += ' <3'
946 * 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)
947 * Don't use PeerTube dependencies. Use your own :)
949 If your plugin is broken with a new PeerTube release, update your code and the `peertubeEngine` field of your `package.json` field.
950 This way, older PeerTube versions will still use your old plugin, and new PeerTube versions will use your updated plugin.
952 ### Spam/moderation plugin
954 If you want to create an antispam/moderation plugin, you could use the following hooks:
955 * `filter:api.video.upload.accept.result`: to accept or not local uploads
956 * `filter:api.video-thread.create.accept.result`: to accept or not local thread
957 * `filter:api.video-comment-reply.create.accept.result`: to accept or not local replies
958 * `filter:api.video-threads.list.result`: to change/hide the text of threads
959 * `filter:api.video-thread-comments.list.result`: to change/hide the text of replies
960 * `filter:video.auto-blacklist.result`: to automatically blacklist local or remote videos
962 ### Other plugin examples
964 You can take a look to "official" PeerTube plugins if you want to take inspiration from them: https://framagit.org/framasoft/peertube/official-plugins