- [Hooks](#hooks)
- [Static files](#static-files)
- [CSS](#css)
- - [Server helpers (only for plugins)](#server-helpers-only-for-plugins)
+ - [Server API (only for plugins)](#server-api-only-for-plugins)
- [Settings](#settings)
- [Storage](#storage)
- [Update video constants](#update-video-constants)
- [Add custom routes](#add-custom-routes)
- [Add external auth methods](#add-external-auth-methods)
- - [Client helpers (themes & plugins)](#client-helpers-themes--plugins)
+ - [Add new transcoding profiles](#add-new-transcoding-profiles)
+ - [Server helpers](#server-helpers)
+ - [Client API (themes & plugins)](#client-api-themes--plugins)
- [Plugin static route](#plugin-static-route)
- [Notifier](#notifier)
- [Markdown Renderer](#markdown-renderer)
+ - [Auth header](#auth-header)
- [Custom Modal](#custom-modal)
- [Translate](#translate)
- [Get public settings](#get-public-settings)
+ - [Get server config](#get-server-config)
- [Add custom fields to video form](#add-custom-fields-to-video-form)
- - [Add new transcoding profiles](#add-new-transcoding-profiles)
+ - [Register settings script](#register-settings-script)
+ - [HTML placeholder elements](#html-placeholder-elements)
- [Publishing](#publishing)
- [Write a plugin/theme](#write-a-plugintheme)
- [Clone the quickstart repository](#clone-the-quickstart-repository)
}
```
-### Server helpers (only for plugins)
+### Server API (only for plugins)
#### Settings
Plugins can register settings, that PeerTube will inject in the administration interface.
+The following fields will be automatically translated using the plugin translation files: `label`, `html`, `descriptionHTML`, `options.label`.
+**These fields are injected in the plugin settings page as HTML, so pay attention to your translation files.**
Example:
```js
-registerSetting({
- name: 'admin-name',
- label: 'Admin name',
- type: 'input',
- // type: input | input-checkbox | input-password | input-textarea | markdown-text | markdown-enhanced
- default: 'my super name'
-})
+function register (...) {
+ registerSetting({
+ name: 'admin-name',
+ label: 'Admin name',
+ type: 'input',
+ // type: input | input-checkbox | input-password | input-textarea | markdown-text | markdown-enhanced | 'select' | 'html'
+ default: 'my super name'
+ })
-const adminName = await settingsManager.getSetting('admin-name')
+ const adminName = await settingsManager.getSetting('admin-name')
-const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ])
-result['admin-name]
+ const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ])
+ result['admin-name]
-settingsManager.onSettingsChange(settings => {
- settings['admin-name])
-})
+ settingsManager.onSettingsChange(settings => {
+ settings['admin-name])
+ })
+}
```
#### Storage
Example:
```js
-const value = await storageManager.getData('mykey')
-await storageManager.storeData('mykey', { subkey: 'value' })
+function register ({
+ storageManager
+}) {
+ const value = await storageManager.getData('mykey')
+ await storageManager.storeData('mykey', { subkey: 'value' })
+}
+```
+
+You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**.
+This directory and its content won't be deleted when your plugin is uninstalled/upgraded.
+
+```js
+function register ({
+ storageManager,
+ peertubeHelpers
+}) {
+ const basePath = peertubeHelpers.plugin.getDataDirectoryPath()
+
+ fs.writeFile(path.join(basePath, 'filename.txt'), 'content of my file', function (err) {
+ ...
+ })
+}
```
#### Update video constants
You can add/delete video categories, licences or languages using the appropriate managers:
```js
-videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
-videoLanguageManager.deleteLanguage('fr')
+function register (...) {
+ videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
+ videoLanguageManager.deleteLanguage('fr')
-videoCategoryManager.addCategory(42, 'Best category')
-videoCategoryManager.deleteCategory(1) // Music
+ videoCategoryManager.addCategory(42, 'Best category')
+ videoCategoryManager.deleteCategory(1) // Music
-videoLicenceManager.addLicence(42, 'Best licence')
-videoLicenceManager.deleteLicence(7) // Public domain
+ videoLicenceManager.addLicence(42, 'Best licence')
+ videoLicenceManager.deleteLicence(7) // Public domain
-videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy
-playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy
+ videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy
+ playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy
+}
```
#### Add custom routes
You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin:
```js
-const router = getRouter()
-router.get('/ping', (req, res) => res.json({ message: 'pong' }))
+function register ({
+ router
+}) {
+ const router = getRouter()
+ router.get('/ping', (req, res) => res.json({ message: 'pong' }))
+
+ // Users are automatically authenticated
+ router.get('/auth', (res, res) => {
+ const user = peertubeHelpers.user.getAuthUser(res)
+
+ const isAdmin = user.role === 0
+ const isModerator = user.role === 1
+ const isUser = user.role === 2
+
+ res.json({
+ username: user.username,
+ isAdmin,
+ isModerator,
+ isUser
+ })
+ })
+}
```
The `ping` route can be accessed using:
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):
```js
-registerIdAndPassAuth({
- authName: 'my-auth-method',
+function register (...) {
- // PeerTube will try all id and pass plugins in the weight DESC order
- // Exposing this value in the plugin settings could be interesting
- getWeight: () => 60,
+ registerIdAndPassAuth({
+ authName: 'my-auth-method',
- // Optional function called by PeerTube when the user clicked on the logout button
- onLogout: user => {
- console.log('User %s logged out.', user.username')
- },
+ // PeerTube will try all id and pass plugins in the weight DESC order
+ // Exposing this value in the plugin settings could be interesting
+ getWeight: () => 60,
- // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
- hookTokenValidity: ({ token, type }) => {
- if (type === 'access') return { valid: true }
- if (type === 'refresh') return { valid: false }
- },
+ // Optional function called by PeerTube when the user clicked on the logout button
+ onLogout: user => {
+ console.log('User %s logged out.', user.username')
+ },
+
+ // Optional function called by PeerTube when the access token or refresh token are generated/refreshed
+ hookTokenValidity: ({ token, type }) => {
+ if (type === 'access') return { valid: true }
+ if (type === 'refresh') return { valid: false }
+ },
+
+ // Used by PeerTube when the user tries to authenticate
+ login: ({ id, password }) => {
+ if (id === 'user' && password === 'super password') {
+ return {
+ username: 'user'
+ email: 'user@example.com'
+ role: 2
+ displayName: 'User display name'
+ }
+ }
+
+ // Auth failed
+ return null
+ }
+ })
+
+ // Unregister this auth method
+ unregisterIdAndPassAuth('my-auth-method')
+}
+```
+
+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):
+
+```js
+function register (...) {
+
+ // result contains the userAuthenticated auth method you can call to authenticate a user
+ const result = registerExternalAuth({
+ authName: 'my-auth-method',
+
+ // Will be displayed in a button next to the login form
+ authDisplayName: () => 'Auth method'
+
+ // If the user click on the auth button, PeerTube will forward the request in this function
+ onAuthRequest: (req, res) => {
+ res.redirect('https://external-auth.example.com/auth')
+ },
+
+ // Same than registerIdAndPassAuth option
+ // onLogout: ...
+
+ // Same than registerIdAndPassAuth option
+ // hookTokenValidity: ...
+ })
+
+ router.use('/external-auth-callback', (req, res) => {
+ // Forward the request to PeerTube
+ result.userAuthenticated({
+ req,
+ res,
+ username: 'user'
+ email: 'user@example.com'
+ role: 2
+ displayName: 'User display name'
+ })
+ })
+
+ // Unregister this external auth method
+ unregisterExternalAuth('my-auth-method)
+}
+```
+
+#### Add new transcoding profiles
+
+Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
+A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
+
+```js
+async function register ({
+ transcodingManager
+}) {
- // Used by PeerTube when the user tries to authenticate
- login: ({ id, password }) => {
- if (id === 'user' && password === 'super password') {
+ // Adapt bitrate when using libx264 encoder
+ {
+ const builder = (options) => {
+ const { input, resolution, fps, streamNum } = options
+
+ const streamString = streamNum ? ':' + streamNum : ''
+
+ // You can also return a promise
+ // All these options are optional
return {
- username: 'user'
- email: 'user@example.com'
- role: 2
- displayName: 'User display name'
+ scaleFilter: {
+ // Used to define an alternative scale filter, needed by some encoders
+ // Default to 'scale'
+ name: 'scale_vaapi'
+ },
+ // Default to []
+ inputOptions: [],
+ // Default to []
+ outputOptions: [
+ // Use a custom bitrate
+ '-b' + streamString + ' 10K'
+ ]
}
}
- // Auth failed
- return null
+ const encoder = 'libx264'
+ const profileName = 'low-quality'
+
+ // Support this profile for VOD transcoding
+ transcodingManager.addVODProfile(encoder, profileName, builder)
+
+ // And/Or support this profile for live transcoding
+ transcodingManager.addLiveProfile(encoder, profileName, builder)
}
-})
-// Unregister this auth method
-unregisterIdAndPassAuth('my-auth-method')
+ {
+ const builder = (options) => {
+ const { streamNum } = options
+
+ const streamString = streamNum ? ':' + streamNum : ''
+
+ // Always copy stream when PeerTube use libfdk_aac or aac encoders
+ return {
+ copy: true
+ }
+ }
+
+ const profileName = 'copy-audio'
+
+ for (const encoder of [ 'libfdk_aac', 'aac' ]) {
+ transcodingManager.addVODProfile(encoder, profileName, builder)
+ }
+ }
```
-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):
+PeerTube will try different encoders depending on their priority.
+If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
+Plugins can change the order of these encoders and add their custom encoders:
```js
-// result contains the userAuthenticated auth method you can call to authenticate a user
-const result = registerExternalAuth({
- authName: 'my-auth-method',
+async function register ({
+ transcodingManager
+}) {
- // Will be displayed in a button next to the login form
- authDisplayName: () => 'Auth method'
+ // Adapt bitrate when using libx264 encoder
+ {
+ const builder = () => {
+ return {
+ inputOptions: [],
+ outputOptions: []
+ }
+ }
- // If the user click on the auth button, PeerTube will forward the request in this function
- onAuthRequest: (req, res) => {
- res.redirect('https://external-auth.example.com/auth')
- },
+ // Support libopus and libvpx-vp9 encoders (these codecs could be incompatible with the player)
+ transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
- // Same than registerIdAndPassAuth option
- // onLogout: ...
+ // Default priorities are ~100
+ // Lowest priority = 1
+ transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
- // Same than registerIdAndPassAuth option
- // hookTokenValidity: ...
-})
+ transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
+ transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
-router.use('/external-auth-callback', (req, res) => {
- // Forward the request to PeerTube
- result.userAuthenticated({
- req,
- res,
- username: 'user'
- email: 'user@example.com'
- role: 2
- displayName: 'User display name'
- })
-})
+ transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
+ transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
+ }
+```
+
+During live transcode input options are applied once for each target resolution.
+Plugins are responsible for detecting such situation and applying input options only once if necessary.
+
+#### Server helpers
+
+PeerTube provides your plugin some helpers. For example:
+
+```js
+async function register ({
+ peertubeHelpers
+}) {
+ // Block a server
+ {
+ const serverActor = await peertubeHelpers.server.getServerActor()
+
+ await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' })
+ }
-// Unregister this external auth method
-unregisterExternalAuth('my-auth-method)
+ // Load a video
+ {
+ const video = await peertubeHelpers.videos.loadByUrl('...')
+ }
+}
```
-### Client helpers (themes & plugins)
+See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list.
+
+### Client API (themes & plugins)
#### Plugin static route
To get your plugin static route:
```js
-const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
-const imageUrl = baseStaticUrl + '/images/chocobo.png'
+function register (...) {
+ const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
+ const imageUrl = baseStaticUrl + '/images/chocobo.png'
+}
```
#### Notifier
To notify the user with the PeerTube ToastModule:
```js
-const { notifier } = peertubeHelpers
-notifier.success('Success message content.')
-notifier.error('Error message content.')
+function register (...) {
+ const { notifier } = peertubeHelpers
+ notifier.success('Success message content.')
+ notifier.error('Error message content.')
+}
```
#### Markdown Renderer
To render a formatted markdown text to HTML:
```js
-const { markdownRenderer } = peertubeHelpers
+function register (...) {
+ const { markdownRenderer } = peertubeHelpers
-await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
-// return <strong>My Bold Text</strong>
+ await markdownRenderer.textMarkdownToHTML('**My Bold Text**')
+ // return <strong>My Bold Text</strong>
-await markdownRenderer.enhancedMarkdownToHTML('')
-// return <img alt=alt-img src=http://.../my-image.jpg />
+ await markdownRenderer.enhancedMarkdownToHTML('')
+ // return <img alt=alt-img src=http://.../my-image.jpg />
+}
+```
+
+#### Auth header
+
+**PeerTube >= 3.2**
+
+To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers:
+
+```js
+function register (...) {
+ registerHook({
+ target: 'action:auth-user.information-loaded',
+ handler: ({ user }) => {
+
+ // Useless because we have the same info in the ({ user }) parameter
+ // It's just an example
+ fetch('/api/v1/users/me', {
+ method: 'GET',
+ headers: peertubeHelpers.getAuthHeader()
+ }).then(res => res.json())
+ .then(data => console.log('Hi %s.', data.username))
+ }
+ })
+}
```
#### Custom Modal
To show a custom modal:
```js
- peertubeHelpers.showModal({
- title: 'My custom modal title',
- content: '<p>My custom modal content</p>',
- // Optionals parameters :
- // show close icon
- close: true,
- // show cancel button and call action() after hiding modal
- cancel: { value: 'cancel', action: () => {} },
- // show confirm button and call action() after hiding modal
- confirm: { value: 'confirm', action: () => {} },
- })
+function register (...) {
+ peertubeHelpers.showModal({
+ title: 'My custom modal title',
+ content: '<p>My custom modal content</p>',
+ // Optionals parameters :
+ // show close icon
+ close: true,
+ // show cancel button and call action() after hiding modal
+ cancel: { value: 'cancel', action: () => {} },
+ // show confirm button and call action() after hiding modal
+ confirm: { value: 'confirm', action: () => {} },
+ })
+}
```
#### Translate
You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):
```js
-peertubeHelpers.translate('User name')
- .then(translation => console.log('Translated User name by ' + translation))
+function register (...) {
+ peertubeHelpers.translate('User name')
+ .then(translation => console.log('Translated User name by ' + translation))
+}
```
#### Get public settings
To get your public plugin settings:
```js
-peertubeHelpers.getSettings()
- .then(s => {
- if (!s || !s['site-id'] || !s['url']) {
- console.error('Matomo settings are not set.')
- return
- }
+function register (...) {
+ peertubeHelpers.getSettings()
+ .then(s => {
+ if (!s || !s['site-id'] || !s['url']) {
+ console.error('Matomo settings are not set.')
+ return
+ }
- // ...
- })
+ // ...
+ })
+}
+```
+
+#### Get server config
+
+```js
+function register (...) {
+ peertubeHelpers.getServerConfig()
+ .then(config => {
+ console.log('Fetched server config.', config)
+ })
+}
```
#### Add custom fields to video form
}
```
-#### Add new transcoding profiles
+#### Register settings script
-Adding transcoding profiles allow admins to change ffmpeg encoding parameters and/or encoders.
-A transcoding profile has to be chosen by the admin of the instance using the admin configuration.
+To hide some fields in your settings plugin page depending on the form state:
```js
-async function register ({
- transcodingManager
-}) {
-
- // Adapt bitrate when using libx264 encoder
- {
- const builder = (options) => {
- const { input, resolution, fps, streamNum } = options
-
- const streamString = streamNum ? ':' + streamNum : ''
-
- // You can also return a promise
- return {
- outputOptions: [
- // Use a custom bitrate
- '-b' + streamString + ' 10K'
- ]
+async function register ({ registerSettingsScript }) {
+ registerSettingsScript({
+ isSettingHidden: options => {
+ if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') {
+ return true
}
- }
-
- const encoder = 'libx264'
- const profileName = 'low-quality'
-
- // Support this profile for VOD transcoding
- transcodingManager.addVODProfile(encoder, profileName, builder)
-
- // And/Or support this profile for live transcoding
- transcodingManager.addLiveProfile(encoder, profileName, builder)
- }
- {
- const builder = (options) => {
- const { streamNum } = options
-
- const streamString = streamNum ? ':' + streamNum : ''
-
- // Always copy stream when PeerTube use libfdk_aac or aac encoders
- return {
- copy: true
- }
+ return false
}
-
- const profileName = 'copy-audio'
-
- for (const encoder of [ 'libfdk_aac', 'aac' ]) {
- transcodingManager.addVODProfile(encoder, profileName, builder)
- }
- }
+ })
+}
```
-PeerTube will try different encoders depending on their priority.
-If the encoder is not available in the current transcoding profile or in ffmpeg, it tries the next one.
-Plugins can change the order of these encoders and add their custom encoders:
-
-```js
-async function register ({
- transcodingManager
-}) {
-
- // Adapt bitrate when using libx264 encoder
- {
- const builder = () => {
- return {
- outputOptions: []
- }
- }
-
- // Support libopus and libvpx-vp9 encoders, just for the example (PeerTube player is only compatible with h264/aac)
- transcodingManager.addVODProfile('libopus', 'test-vod-profile', builder)
+#### HTML placeholder elements
- // Default priorities are ~100
- // Lowest priority = 1
- transcodingManager.addVODEncoderPriority('audio', 'libopus', 1000)
+PeerTube provides some HTML id so plugins can easily insert their own element:
- transcodingManager.addVODProfile('libvpx-vp9', 'test-vod-profile', builder)
- transcodingManager.addVODEncoderPriority('video', 'libvpx-vp9', 1000)
+```js
+async function register (...) {
+ const elem = document.createElement('div')
+ elem.className = 'hello-world-h4'
+ elem.innerHTML = '<h4>Hello everybody! This is an element next to the player</h4>'
- transcodingManager.addLiveProfile('libopus', 'test-live-profile', builder)
- transcodingManager.addLiveEncoderPriority('audio', 'libopus', 1000)
- }
+ document.getElementById('plugin-placeholder-player-next').appendChild(elem)
+}
```
+See the complete list on https://docs.joinpeertube.org/api-plugins
### Publishing
{
...,
"translations": {
- "fr-FR": "./languages/fr.json",
+ "fr": "./languages/fr.json",
"pt-BR": "./languages/pt-BR.json"
},
...
```
The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts).
-You **must** use the complete locales (`fr-FR` instead of `fr`).
Translation files are just objects, with the english sentence as the key and the translation as the value.
`fr.json` could contain for example:
projects / github / Chocobozzz / PeerTube.git / blobdiff