1 import { RepeatOptions } from 'bullmq'
2 import { Encoding, randomBytes } from 'crypto'
3 import { invert } from 'lodash'
4 import { join } from 'path'
5 import { randomInt, root } from '@shared/core-utils'
10 VideoChannelSyncState,
17 } from '../../shared/models'
18 import { ActivityPubActorType } from '../../shared/models/activitypub'
19 import { ActorImageType, FollowState } from '../../shared/models/actors'
20 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
21 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
22 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
23 // Do not use barrels, remain constants as independent as possible
24 import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
25 import { CONFIG, registerConfigChangedHandler } from './config'
27 // ---------------------------------------------------------------------------
29 const LAST_MIGRATION_VERSION = 760
31 // ---------------------------------------------------------------------------
33 const API_VERSION = 'v1'
34 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
61 // Sortable columns per schema
62 const SORTABLE_COLUMNS = {
63 ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
64 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
65 ACCOUNTS: [ 'createdAt' ],
66 JOBS: [ 'createdAt' ],
67 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
68 VIDEO_IMPORTS: [ 'createdAt' ],
69 VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
71 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
72 VIDEO_COMMENTS: [ 'createdAt' ],
74 VIDEO_RATES: [ 'createdAt' ],
75 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
77 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
78 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
79 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
80 CHANNEL_FOLLOWERS: [ 'createdAt' ],
82 USER_REGISTRATIONS: [ 'createdAt', 'state' ],
84 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
86 // Don't forget to update peertube-search-index with the same values
87 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
88 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
89 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
91 ABUSES: [ 'id', 'createdAt', 'state' ],
93 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
94 SERVERS_BLOCKLIST: [ 'createdAt' ],
96 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
98 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
100 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
102 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
104 VIDEO_REDUNDANCIES: [ 'name' ]
107 const ROUTE_CACHE_LIFETIME = {
111 SECURITYTXT: '2 hours',
112 NODEINFO: '10 minutes',
113 DNT_POLICY: '1 week',
115 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
121 // ---------------------------------------------------------------------------
123 // Number of points we add/remove after a successful/bad request
124 const ACTOR_FOLLOW_SCORE = {
131 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
133 ACCEPTED: 'accepted',
137 const REMOTE_SCHEME = {
142 const JOB_ATTEMPTS: { [id in JobType]: number } = {
143 'activitypub-http-broadcast': 1,
144 'activitypub-http-broadcast-parallel': 1,
145 'activitypub-http-unicast': 1,
146 'activitypub-http-fetcher': 2,
147 'activitypub-follow': 5,
148 'activitypub-cleaner': 1,
149 'video-file-import': 1,
150 'video-transcoding': 1,
154 'videos-views-stats': 1,
155 'activitypub-refresher': 1,
156 'video-redundancy': 1,
157 'video-live-ending': 1,
158 'video-studio-edition': 1,
159 'manage-video-torrent': 1,
160 'video-channel-import': 1,
161 'after-video-channel-import': 1,
162 'move-to-object-storage': 3,
166 // Excluded keys are jobs that can be configured by admins
167 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
168 'activitypub-http-broadcast': 1,
169 'activitypub-http-broadcast-parallel': 30,
170 'activitypub-http-unicast': 30,
171 'activitypub-http-fetcher': 3,
172 'activitypub-cleaner': 1,
173 'activitypub-follow': 1,
174 'video-file-import': 1,
177 'videos-views-stats': 1,
178 'activitypub-refresher': 1,
179 'video-redundancy': 1,
180 'video-live-ending': 10,
181 'video-studio-edition': 1,
182 'manage-video-torrent': 1,
183 'move-to-object-storage': 1,
184 'video-channel-import': 1,
185 'after-video-channel-import': 1,
189 const JOB_TTL: { [id in JobType]: number } = {
190 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
191 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
192 'activitypub-http-unicast': 60000 * 10, // 10 minutes
193 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
194 'activitypub-follow': 60000 * 10, // 10 minutes
195 'activitypub-cleaner': 1000 * 3600, // 1 hour
196 'video-file-import': 1000 * 3600, // 1 hour
197 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
198 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
199 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
200 'email': 60000 * 10, // 10 minutes
201 'actor-keys': 60000 * 20, // 20 minutes
202 'videos-views-stats': undefined, // Unlimited
203 'activitypub-refresher': 60000 * 10, // 10 minutes
204 'video-redundancy': 1000 * 3600 * 3, // 3 hours
205 'video-live-ending': 1000 * 60 * 10, // 10 minutes
206 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
207 'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
208 'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
209 'after-video-channel-import': 60000 * 5, // 5 minutes
210 'notify': 60000 * 5, // 5 minutes
211 'federate-video': 60000 * 5 // 5 minutes
213 const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
214 'videos-views-stats': {
215 pattern: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
217 'activitypub-cleaner': {
218 pattern: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
221 const JOB_PRIORITY = {
225 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
226 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
229 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
230 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
231 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
234 const REQUEST_TIMEOUTS = {
235 DEFAULT: 7000, // 7 seconds
236 FILE: 30000, // 30 seconds
237 REDUNDANCY: JOB_TTL['video-redundancy']
240 const JOB_REMOVAL_OPTIONS = {
241 COUNT: 10000, // Max jobs to store
243 SUCCESS: { // Success jobs
244 'DEFAULT': parseDurationToMs('2 days'),
246 'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
247 'activitypub-http-unicast': parseDurationToMs('1 hour'),
248 'videos-views-stats': parseDurationToMs('3 hours'),
249 'activitypub-refresher': parseDurationToMs('10 hours')
252 FAILURE: { // Failed job
253 DEFAULT: parseDurationToMs('7 days')
257 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
259 const SCHEDULER_INTERVALS_MS = {
260 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
261 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
262 UPDATE_VIDEOS: 60000, // 1 minute
263 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
264 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
265 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
266 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
267 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
268 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
269 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
270 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
271 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
272 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
273 CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
276 // ---------------------------------------------------------------------------
278 const CONSTRAINTS_FIELDS = {
280 NAME: { min: 1, max: 120 }, // Length
281 DESCRIPTION: { min: 3, max: 1000 }, // Length
282 USERNAME: { min: 1, max: 50 }, // Length
283 PASSWORD: { min: 6, max: 255 }, // Length
284 VIDEO_QUOTA: { min: -1 },
285 VIDEO_QUOTA_DAILY: { min: -1 },
286 VIDEO_LANGUAGES: { max: 500 }, // Array length
287 BLOCKED_REASON: { min: 3, max: 250 } // Length
290 REASON: { min: 2, max: 3000 }, // Length
291 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
294 MESSAGE: { min: 2, max: 3000 } // Length
296 USER_REGISTRATIONS: {
297 REASON_MESSAGE: { min: 2, max: 3000 }, // Length
298 MODERATOR_MESSAGE: { min: 2, max: 3000 } // Length
301 REASON: { min: 2, max: 300 } // Length
304 NAME: { min: 1, max: 120 }, // Length
305 DESCRIPTION: { min: 3, max: 1000 }, // Length
306 SUPPORT: { min: 3, max: 1000 }, // Length
307 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
308 URL: { min: 3, max: 2000 } // Length
310 VIDEO_CHANNEL_SYNCS: {
311 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
315 EXTNAME: [ '.vtt', '.srt' ],
317 max: 20 * 1024 * 1024 // 20MB
322 URL: { min: 3, max: 2000 }, // Length
323 TORRENT_NAME: { min: 3, max: 255 }, // Length
325 EXTNAME: [ '.torrent' ],
327 max: 1024 * 200 // 200 KB
332 URL: { min: 3, max: 2000 } // Length
335 URL: { min: 3, max: 2000 } // Length
338 NAME: { min: 3, max: 120 }, // Length
339 LANGUAGE: { min: 1, max: 10 }, // Length
340 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
341 DESCRIPTION: { min: 3, max: 10000 }, // Length
342 SUPPORT: { min: 3, max: 1000 }, // Length
344 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
346 max: 4 * 1024 * 1024 // 4MB
349 EXTNAME: [] as string[],
350 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
351 DURATION: { min: 0 }, // Number
352 TAGS: { min: 0, max: 5 }, // Number of total tags
353 TAG: { min: 2, max: 30 }, // Length
356 DISLIKES: { min: 0 },
357 FILE_SIZE: { min: -1 },
358 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
359 URL: { min: 3, max: 2000 } // Length
362 NAME: { min: 1, max: 120 }, // Length
363 DESCRIPTION: { min: 3, max: 1000 }, // Length
364 URL: { min: 3, max: 2000 }, // Length
366 EXTNAME: [ '.jpg', '.jpeg' ],
368 max: 4 * 1024 * 1024 // 4MB
373 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
374 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
375 URL: { min: 3, max: 2000 }, // Length
377 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
379 max: 4 * 1024 * 1024 // 4MB
387 TEXT: { min: 1, max: 10000 }, // Length
388 URL: { min: 3, max: 2000 } // Length
391 URL: { min: 3, max: 2000 } // Length
394 FROM_NAME: { min: 1, max: 120 }, // Length
395 BODY: { min: 3, max: 5000 } // Length
398 NAME: { min: 1, max: 214 }, // Length
399 DESCRIPTION: { min: 1, max: 20000 } // Length
402 URL: { min: 5, max: 2000 } // Length
405 TASKS: { min: 1, max: 10 }, // Number of tasks
406 CUT_TIME: { min: 0 } // Value
409 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
410 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
411 CLIENT_META: { min: 1, max: 5000 }, // Length
412 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
416 const VIEW_LIFETIME = {
417 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
418 VIEWER_COUNTER: 60000 * 2, // 2 minutes
419 VIEWER_STATS: 60000 * 60 // 1 hour
422 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
424 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
426 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
428 STANDARD: [ 24, 25, 30 ],
429 HD_STANDARD: [ 50, 60 ],
433 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
436 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
438 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
443 const FFMPEG_NICE: { [ id: string ]: number } = {
444 // parent process defaults to niceness = 0
445 // reminder: lower = higher priority, max value is 19, lowest is -20
446 LIVE: 5, // prioritize over VOD and THUMBNAIL
451 const VIDEO_CATEGORIES = {
462 11: 'News & Politics',
466 15: 'Science & Technology',
472 // See https://creativecommons.org/licenses/?lang=en
473 const VIDEO_LICENCES = {
475 2: 'Attribution - Share Alike',
476 3: 'Attribution - No Derivatives',
477 4: 'Attribution - Non Commercial',
478 5: 'Attribution - Non Commercial - Share Alike',
479 6: 'Attribution - Non Commercial - No Derivatives',
480 7: 'Public Domain Dedication'
483 const VIDEO_LANGUAGES: { [id: string]: string } = {}
485 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
486 [VideoPrivacy.PUBLIC]: 'Public',
487 [VideoPrivacy.UNLISTED]: 'Unlisted',
488 [VideoPrivacy.PRIVATE]: 'Private',
489 [VideoPrivacy.INTERNAL]: 'Internal'
492 const VIDEO_STATES: { [ id in VideoState ]: string } = {
493 [VideoState.PUBLISHED]: 'Published',
494 [VideoState.TO_TRANSCODE]: 'To transcode',
495 [VideoState.TO_IMPORT]: 'To import',
496 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
497 [VideoState.LIVE_ENDED]: 'Livestream ended',
498 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
499 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
500 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
501 [VideoState.TO_EDIT]: 'To edit*'
504 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
505 [VideoImportState.FAILED]: 'Failed',
506 [VideoImportState.PENDING]: 'Pending',
507 [VideoImportState.SUCCESS]: 'Success',
508 [VideoImportState.REJECTED]: 'Rejected',
509 [VideoImportState.CANCELLED]: 'Cancelled',
510 [VideoImportState.PROCESSING]: 'Processing'
513 const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
514 [VideoChannelSyncState.FAILED]: 'Failed',
515 [VideoChannelSyncState.SYNCED]: 'Synchronized',
516 [VideoChannelSyncState.PROCESSING]: 'Processing',
517 [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
520 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
521 [AbuseState.PENDING]: 'Pending',
522 [AbuseState.REJECTED]: 'Rejected',
523 [AbuseState.ACCEPTED]: 'Accepted'
526 const USER_REGISTRATION_STATES: { [ id in UserRegistrationState ]: string } = {
527 [UserRegistrationState.PENDING]: 'Pending',
528 [UserRegistrationState.REJECTED]: 'Rejected',
529 [UserRegistrationState.ACCEPTED]: 'Accepted'
532 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
533 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
534 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
535 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
538 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
539 [VideoPlaylistType.REGULAR]: 'Regular',
540 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
546 'audio/mpeg': '.mp3',
549 'application/ogg': '.ogg',
552 'audio/x-ms-wma': '.wma',
554 'audio/x-wav': '.wav',
556 'audio/x-flac': '.flac',
557 'audio/flac': '.flac',
559 'audio/vnd.dlna.adts': '.aac',
564 'audio/x-m4a': '.m4a',
566 'audio/vnd.dolby.dd-raw': '.ac3',
569 EXT_MIMETYPE: null as { [ id: string ]: string }
572 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
573 MIMETYPES_REGEX: null as string,
574 EXT_MIMETYPE: null as { [ id: string ]: string }
580 'image/webp': '.webp',
584 EXT_MIMETYPE: null as { [ id: string ]: string }
589 'application/x-subrip': '.srt',
595 'application/x-bittorrent': '.torrent'
599 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
600 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
602 const BINARY_CONTENT_TYPES = new Set([
603 'binary/octet-stream',
604 'application/octet-stream',
605 'application/x-binary'
608 // ---------------------------------------------------------------------------
617 // ---------------------------------------------------------------------------
619 const SERVER_ACTOR_NAME = 'peertube'
621 const ACTIVITY_PUB = {
622 POTENTIAL_ACCEPT_HEADERS: [
623 'application/activity+json',
624 'application/ld+json',
625 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
627 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
628 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
629 COLLECTION_ITEMS_PER_PAGE: 10,
630 FETCH_PAGE_LIMIT: 2000,
632 VIDEO: [] as string[],
633 TORRENT: [ 'application/x-bittorrent' ],
634 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
636 MAX_RECURSION_COMMENTS: 100,
637 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
638 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
639 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
642 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
645 APPLICATION: 'Application',
646 ORGANIZATION: 'Organization',
650 const HTTP_SIGNATURE = {
651 HEADER_NAME: 'signature',
652 ALGORITHM: 'rsa-sha256',
653 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
654 CLOCK_SKEW_SECONDS: 1800
657 // ---------------------------------------------------------------------------
659 let PRIVATE_RSA_KEY_SIZE = 2048
661 // Password encryption
662 const BCRYPT_SALT_SIZE = 10
665 ALGORITHM: 'aes-256-cbc',
668 ENCODING: 'hex' as Encoding
671 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
672 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
674 const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
676 const EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
678 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
679 DO_NOT_LIST: 'do_not_list',
684 // ---------------------------------------------------------------------------
686 // Express static paths (router)
687 const STATIC_PATHS = {
688 THUMBNAILS: '/static/thumbnails/',
690 WEBSEED: '/static/webseed/',
691 PRIVATE_WEBSEED: '/static/webseed/private/',
693 REDUNDANCY: '/static/redundancy/',
695 STREAMING_PLAYLISTS: {
696 HLS: '/static/streaming-playlists/hls',
697 PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
700 const STATIC_DOWNLOAD_PATHS = {
701 TORRENTS: '/download/torrents/',
702 VIDEOS: '/download/videos/',
703 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
705 const LAZY_STATIC_PATHS = {
706 BANNERS: '/lazy-static/banners/',
707 AVATARS: '/lazy-static/avatars/',
708 PREVIEWS: '/lazy-static/previews/',
709 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
710 TORRENTS: '/lazy-static/torrents/'
712 const OBJECT_STORAGE_PROXY_PATHS = {
713 PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
715 STREAMING_PLAYLISTS: {
716 PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
721 const STATIC_MAX_AGE = {
727 // Videos thumbnail size
728 const THUMBNAILS_SIZE = {
733 const PREVIEWS_SIZE = {
738 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
739 [ActorImageType.AVATAR]: [
749 [ActorImageType.BANNER]: [
752 height: 317 // 6/1 ratio
762 // Sub folders of cache directory
763 const FILES_CACHE = {
765 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
766 MAX_AGE: 1000 * 3600 * 3 // 3 hours
769 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
770 MAX_AGE: 1000 * 3600 * 3 // 3 hours
773 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
774 MAX_AGE: 1000 * 3600 * 3 // 3 hours
782 ACTOR_IMAGE_STATIC: {
785 STATIC_VIDEO_FILES_RIGHTS_CHECK: {
787 TTL: parseDurationToMs('10 seconds')
791 TTL: parseDurationToMs('8 hours')
798 const DIRECTORIES = {
799 RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
801 HLS_STREAMING_PLAYLIST: {
802 PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
803 PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
807 PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
808 PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
811 HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
814 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
818 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
819 SEGMENT_TIME_SECONDS: {
820 DEFAULT_LATENCY: 4, // 4 seconds
821 SMALL_LATENCY: 2 // 2 seconds
823 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
824 REPLAY_DIRECTORY: 'replay',
825 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
826 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
836 const MEMOIZE_TTL = {
837 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
838 INFO_HASH_EXISTS: 1000 * 60, // 1 minute
839 VIDEO_DURATION: 1000 * 10, // 10 seconds
840 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
841 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
842 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
845 const MEMOIZE_LENGTH = {
846 INFO_HASH_EXISTS: 200,
850 const WORKER_THREADS = {
867 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
869 HEADER_NAME: 'x-peertube-otp',
870 HEADER_REQUIRED_VALUE: 'required; app'
873 const ASSETS_PATH = {
874 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
875 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
878 // ---------------------------------------------------------------------------
880 const CUSTOM_HTML_TAG_COMMENTS = {
881 TITLE: '<!-- title tag -->',
882 DESCRIPTION: '<!-- description tag -->',
883 CUSTOM_CSS: '<!-- custom css tag -->',
884 META_TAGS: '<!-- meta tags -->',
885 SERVER_CONFIG: '<!-- server config -->'
888 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
889 const LOG_FILENAME = 'peertube.log'
890 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
892 // ---------------------------------------------------------------------------
894 const TRACKER_RATE_LIMITS = {
895 INTERVAL: 60000 * 5, // 5 minutes
896 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
897 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
898 BLOCK_IP_LIFETIME: parseDurationToMs('3 minutes')
901 const P2P_MEDIA_LOADER_PEER_VERSION = 2
903 // ---------------------------------------------------------------------------
905 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
906 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
908 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
910 const DEFAULT_THEME_NAME = 'default'
911 const DEFAULT_USER_THEME_NAME = 'instance-default'
913 // ---------------------------------------------------------------------------
915 const SEARCH_INDEX = {
917 VIDEOS: '/api/v1/search/videos',
918 VIDEO_CHANNELS: '/api/v1/search/video-channels'
922 // ---------------------------------------------------------------------------
924 const STATS_TIMESERIE = {
925 MAX_DAYS: 365 * 10 // Around 10 years
928 // ---------------------------------------------------------------------------
930 // Special constants for a test instance
931 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
932 if (isTestOrDevInstance()) {
933 PRIVATE_RSA_KEY_SIZE = 1024
935 ACTOR_FOLLOW_SCORE.BASE = 20
937 REMOTE_SCHEME.HTTP = 'http'
938 REMOTE_SCHEME.WS = 'ws'
940 STATIC_MAX_AGE.SERVER = '0'
942 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
943 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
944 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
945 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
946 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
947 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
948 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
949 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
951 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
953 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
954 AP_CLEANER.PERIOD = 5000
956 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
958 CONTACT_FORM_LIFETIME = 1000 // 1 second
960 JOB_ATTEMPTS['email'] = 1
962 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
963 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
964 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
965 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
967 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
969 JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
972 if (isTestInstance()) {
973 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
974 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
975 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
976 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
978 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
979 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
981 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
982 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
984 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
985 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
986 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
987 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
991 updateWebserverUrls()
992 updateWebserverConfig()
994 registerConfigChangedHandler(() => {
995 updateWebserverUrls()
996 updateWebserverConfig()
999 // ---------------------------------------------------------------------------
1001 const FILES_CONTENT_HASH = {
1002 MANIFEST: generateContentHash(),
1003 FAVICON: generateContentHash(),
1004 LOGO: generateContentHash()
1007 // ---------------------------------------------------------------------------
1009 const VIDEO_FILTERS = {
1012 HORIZONTAL_MARGIN_RATIO: 1 / 20,
1013 VERTICAL_MARGIN_RATIO: 1 / 20
1017 // ---------------------------------------------------------------------------
1026 OBJECT_STORAGE_PROXY_PATHS,
1029 RESUMABLE_UPLOAD_SESSION_LIFETIME,
1030 P2P_MEDIA_LOADER_PEER_VERSION,
1034 TRACKER_RATE_LIMITS,
1043 LAST_MIGRATION_VERSION,
1044 CUSTOM_HTML_TAG_COMMENTS,
1046 BROADCAST_CONCURRENCY,
1053 DEFAULT_USER_THEME_NAME,
1055 TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
1056 PLUGIN_GLOBAL_CSS_FILE_NAME,
1057 PLUGIN_GLOBAL_CSS_PATH,
1058 PRIVATE_RSA_KEY_SIZE,
1060 ROUTE_CACHE_LIFETIME,
1067 VIDEO_IMPORT_TIMEOUT,
1068 VIDEO_PLAYLIST_TYPES,
1069 MAX_LOGS_OUTPUT_CHARACTERS,
1071 ACTIVITY_PUB_ACTOR_TYPES,
1082 VIDEO_TRANSCODING_FPS,
1085 USER_REGISTRATION_STATES,
1088 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
1089 USER_PASSWORD_RESET_LIFETIME,
1090 USER_PASSWORD_CREATE_LIFETIME,
1092 EMAIL_VERIFY_LIFETIME,
1094 SCHEDULER_INTERVALS_MS,
1096 STATIC_DOWNLOAD_PATHS,
1098 CRAWL_REQUEST_CONCURRENCY,
1099 DEFAULT_AUDIO_RESOLUTION,
1100 BINARY_CONTENT_TYPES,
1101 JOB_REMOVAL_OPTIONS,
1103 VIDEO_IMPORT_STATES,
1104 VIDEO_CHANNEL_SYNC_STATE,
1106 CONTACT_FORM_LIFETIME,
1107 VIDEO_PLAYLIST_PRIVACIES,
1108 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1117 // ---------------------------------------------------------------------------
1119 function buildVideoMimetypeExt () {
1121 // streamable formats that warrant cross-browser compatibility
1122 'video/webm': '.webm',
1123 // We'll add .ogg if additional extensions are enabled
1124 // We could add .ogg here but since it could be an audio file,
1125 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1126 'video/ogg': [ '.ogv' ],
1130 if (CONFIG.TRANSCODING.ENABLED) {
1131 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1132 data['video/ogg'].push('.ogg')
1134 Object.assign(data, {
1135 'video/x-matroska': '.mkv',
1137 // Developed by Apple
1138 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1139 'video/x-m4v': '.m4v',
1140 'video/m4v': '.m4v',
1142 // Developed by the Adobe Flash Platform
1143 'video/x-flv': '.flv',
1144 'video/x-f4v': '.f4v', // replacement for flv
1146 // Developed by Microsoft
1147 'video/x-ms-wmv': '.wmv',
1148 'video/x-msvideo': '.avi',
1149 'video/avi': '.avi',
1151 // Developed by 3GPP
1152 // common video formats for cell phones
1153 'video/3gpp': [ '.3gp', '.3gpp' ],
1154 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1156 // Developed by FFmpeg/Mplayer
1157 'application/x-nut': '.nut',
1159 // The standard video format used by many Sony and Panasonic HD camcorders.
1160 // It is also used for storing high definition video on Blu-ray discs.
1161 'video/mp2t': '.mts',
1162 'video/vnd.dlna.mpeg-tts': '.mts',
1164 'video/m2ts': '.m2ts',
1166 // Old formats reliant on MPEG-1/MPEG-2
1167 'video/mpv': '.mpv',
1168 'video/mpeg2': '.m2v',
1169 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1170 'video/dvd': '.vob',
1172 // Could be anything
1173 'application/octet-stream': null,
1174 'application/mxf': '.mxf' // often used as exchange format by editing software
1178 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1179 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1186 function updateWebserverUrls () {
1187 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1188 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1189 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1191 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1192 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1193 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1195 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1196 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1198 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1199 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1202 function updateWebserverConfig () {
1203 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1204 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1206 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1208 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1210 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1213 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1214 const result: { [id: string]: string } = {}
1216 for (const mimetype of Object.keys(obj)) {
1217 const value = obj[mimetype]
1218 if (!value) continue
1220 const extensions = Array.isArray(value) ? value : [ value ]
1222 for (const extension of extensions) {
1223 result[extension] = mimetype
1230 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1231 return Object.keys(obj)
1236 function loadLanguages () {
1237 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1240 function buildLanguages () {
1241 const iso639 = require('iso-639-3')
1243 const languages: { [id: string]: string } = {}
1245 const additionalLanguages = {
1246 sgn: true, // Sign languages (macro language)
1247 ase: true, // American sign language
1248 asq: true, // Austrian sign language
1249 sdl: true, // Arabian sign language
1250 bfi: true, // British sign language
1251 bzs: true, // Brazilian sign language
1252 csl: true, // Chinese sign language
1253 cse: true, // Czech sign language
1254 dsl: true, // Danish sign language
1255 fsl: true, // French sign language
1256 gsg: true, // German sign language
1257 pks: true, // Pakistan sign language
1258 jsl: true, // Japanese sign language
1259 sfs: true, // South African sign language
1260 swl: true, // Swedish sign language
1261 rsl: true, // Russian sign language
1263 kab: true, // Kabyle
1267 epo: true, // Esperanto
1268 tlh: true, // Klingon
1269 jbo: true, // Lojban
1270 avk: true, // Kotava
1272 zxx: true // No linguistic content (ISO-639-2)
1275 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1278 return (l.iso6391 !== undefined && l.type === 'living') ||
1279 additionalLanguages[l.iso6393] === true
1281 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1283 // Override Occitan label
1284 languages['oc'] = 'Occitan'
1285 languages['el'] = 'Greek'
1286 languages['tok'] = 'Toki Pona'
1288 // Chinese languages
1289 languages['zh-Hans'] = 'Simplified Chinese'
1290 languages['zh-Hant'] = 'Traditional Chinese'
1295 function generateContentHash () {
1296 return randomBytes(20).toString('hex')
1299 function getIntEnv (path: string) {
1300 if (process.env[path]) return parseInt(process.env[path])