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'
16 } from '../../shared/models'
17 import { ActivityPubActorType } from '../../shared/models/activitypub'
18 import { ActorImageType, FollowState } from '../../shared/models/actors'
19 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
20 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
21 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
22 // Do not use barrels, remain constants as independent as possible
23 import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
24 import { CONFIG, registerConfigChangedHandler } from './config'
26 // ---------------------------------------------------------------------------
28 const LAST_MIGRATION_VERSION = 745
30 // ---------------------------------------------------------------------------
32 const API_VERSION = 'v1'
33 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
60 // Sortable columns per schema
61 const SORTABLE_COLUMNS = {
62 ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
63 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
64 ACCOUNTS: [ 'createdAt' ],
65 JOBS: [ 'createdAt' ],
66 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
67 VIDEO_IMPORTS: [ 'createdAt' ],
68 VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
70 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
71 VIDEO_COMMENTS: [ 'createdAt' ],
73 VIDEO_RATES: [ 'createdAt' ],
74 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
76 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
77 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
78 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
79 CHANNEL_FOLLOWERS: [ 'createdAt' ],
81 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
83 // Don't forget to update peertube-search-index with the same values
84 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
85 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
86 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
88 ABUSES: [ 'id', 'createdAt', 'state' ],
90 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
91 SERVERS_BLOCKLIST: [ 'createdAt' ],
93 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
95 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
97 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
99 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
101 VIDEO_REDUNDANCIES: [ 'name' ]
104 const OAUTH_LIFETIME = {
105 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
106 REFRESH_TOKEN: 1209600 // 2 weeks
109 const ROUTE_CACHE_LIFETIME = {
113 SECURITYTXT: '2 hours',
114 NODEINFO: '10 minutes',
115 DNT_POLICY: '1 week',
117 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
123 // ---------------------------------------------------------------------------
125 // Number of points we add/remove after a successful/bad request
126 const ACTOR_FOLLOW_SCORE = {
133 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
135 ACCEPTED: 'accepted',
139 const REMOTE_SCHEME = {
144 const JOB_ATTEMPTS: { [id in JobType]: number } = {
145 'activitypub-http-broadcast': 1,
146 'activitypub-http-broadcast-parallel': 1,
147 'activitypub-http-unicast': 1,
148 'activitypub-http-fetcher': 2,
149 'activitypub-follow': 5,
150 'activitypub-cleaner': 1,
151 'video-file-import': 1,
152 'video-transcoding': 1,
156 'videos-views-stats': 1,
157 'activitypub-refresher': 1,
158 'video-redundancy': 1,
159 'video-live-ending': 1,
160 'video-studio-edition': 1,
161 'manage-video-torrent': 1,
162 'video-channel-import': 1,
163 'after-video-channel-import': 1,
164 'move-to-object-storage': 3,
168 // Excluded keys are jobs that can be configured by admins
169 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
170 'activitypub-http-broadcast': 1,
171 'activitypub-http-broadcast-parallel': 30,
172 'activitypub-http-unicast': 10,
173 'activitypub-http-fetcher': 3,
174 'activitypub-cleaner': 1,
175 'activitypub-follow': 1,
176 'video-file-import': 1,
179 'videos-views-stats': 1,
180 'activitypub-refresher': 1,
181 'video-redundancy': 1,
182 'video-live-ending': 10,
183 'video-studio-edition': 1,
184 'manage-video-torrent': 1,
185 'move-to-object-storage': 1,
186 'video-channel-import': 1,
187 'after-video-channel-import': 1,
191 const JOB_TTL: { [id in JobType]: number } = {
192 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
193 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
194 'activitypub-http-unicast': 60000 * 10, // 10 minutes
195 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
196 'activitypub-follow': 60000 * 10, // 10 minutes
197 'activitypub-cleaner': 1000 * 3600, // 1 hour
198 'video-file-import': 1000 * 3600, // 1 hour
199 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
200 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
201 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
202 'email': 60000 * 10, // 10 minutes
203 'actor-keys': 60000 * 20, // 20 minutes
204 'videos-views-stats': undefined, // Unlimited
205 'activitypub-refresher': 60000 * 10, // 10 minutes
206 'video-redundancy': 1000 * 3600 * 3, // 3 hours
207 'video-live-ending': 1000 * 60 * 10, // 10 minutes
208 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
209 'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
210 'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
211 'after-video-channel-import': 60000 * 5, // 5 minutes
212 'notify': 60000 * 5, // 5 minutes
213 'federate-video': 60000 * 5 // 5 minutes
215 const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
216 'videos-views-stats': {
217 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
219 'activitypub-cleaner': {
220 cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
223 const JOB_PRIORITY = {
227 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
228 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
231 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
232 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
233 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
236 const REQUEST_TIMEOUTS = {
237 DEFAULT: 7000, // 7 seconds
238 FILE: 30000, // 30 seconds
239 REDUNDANCY: JOB_TTL['video-redundancy']
242 const JOB_REMOVAL_OPTIONS = {
243 COUNT: 10000, // Max jobs to store
245 SUCCESS: { // Success jobs
246 'DEFAULT': parseDurationToMs('2 days'),
248 'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
249 'activitypub-http-unicast': parseDurationToMs('1 hour'),
250 'videos-views-stats': parseDurationToMs('3 hours'),
251 'activitypub-refresher': parseDurationToMs('10 hours')
254 FAILURE: { // Failed job
255 DEFAULT: parseDurationToMs('7 days')
259 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
261 const SCHEDULER_INTERVALS_MS = {
262 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
263 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
264 UPDATE_VIDEOS: 60000, // 1 minute
265 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
266 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
267 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
268 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
269 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
270 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
271 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
272 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
273 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
274 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
275 CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
278 // ---------------------------------------------------------------------------
280 const CONSTRAINTS_FIELDS = {
282 NAME: { min: 1, max: 120 }, // Length
283 DESCRIPTION: { min: 3, max: 1000 }, // Length
284 USERNAME: { min: 1, max: 50 }, // Length
285 PASSWORD: { min: 6, max: 255 }, // Length
286 VIDEO_QUOTA: { min: -1 },
287 VIDEO_QUOTA_DAILY: { min: -1 },
288 VIDEO_LANGUAGES: { max: 500 }, // Array length
289 BLOCKED_REASON: { min: 3, max: 250 } // Length
292 REASON: { min: 2, max: 3000 }, // Length
293 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
296 MESSAGE: { min: 2, max: 3000 } // Length
299 REASON: { min: 2, max: 300 } // Length
302 NAME: { min: 1, max: 120 }, // Length
303 DESCRIPTION: { min: 3, max: 1000 }, // Length
304 SUPPORT: { min: 3, max: 1000 }, // Length
305 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
306 URL: { min: 3, max: 2000 } // Length
308 VIDEO_CHANNEL_SYNCS: {
309 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
313 EXTNAME: [ '.vtt', '.srt' ],
315 max: 20 * 1024 * 1024 // 20MB
320 URL: { min: 3, max: 2000 }, // Length
321 TORRENT_NAME: { min: 3, max: 255 }, // Length
323 EXTNAME: [ '.torrent' ],
325 max: 1024 * 200 // 200 KB
330 URL: { min: 3, max: 2000 } // Length
333 URL: { min: 3, max: 2000 } // Length
336 NAME: { min: 3, max: 120 }, // Length
337 LANGUAGE: { min: 1, max: 10 }, // Length
338 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
339 DESCRIPTION: { min: 3, max: 10000 }, // Length
340 SUPPORT: { min: 3, max: 1000 }, // Length
342 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
344 max: 4 * 1024 * 1024 // 4MB
347 EXTNAME: [] as string[],
348 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
349 DURATION: { min: 0 }, // Number
350 TAGS: { min: 0, max: 5 }, // Number of total tags
351 TAG: { min: 2, max: 30 }, // Length
354 DISLIKES: { min: 0 },
355 FILE_SIZE: { min: -1 },
356 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
357 URL: { min: 3, max: 2000 } // Length
360 NAME: { min: 1, max: 120 }, // Length
361 DESCRIPTION: { min: 3, max: 1000 }, // Length
362 URL: { min: 3, max: 2000 }, // Length
364 EXTNAME: [ '.jpg', '.jpeg' ],
366 max: 4 * 1024 * 1024 // 4MB
371 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
372 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
373 URL: { min: 3, max: 2000 }, // Length
375 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
377 max: 4 * 1024 * 1024 // 4MB
385 TEXT: { min: 1, max: 10000 }, // Length
386 URL: { min: 3, max: 2000 } // Length
389 URL: { min: 3, max: 2000 } // Length
392 FROM_NAME: { min: 1, max: 120 }, // Length
393 BODY: { min: 3, max: 5000 } // Length
396 NAME: { min: 1, max: 214 }, // Length
397 DESCRIPTION: { min: 1, max: 20000 } // Length
400 URL: { min: 5, max: 2000 } // Length
403 TASKS: { min: 1, max: 10 }, // Number of tasks
404 CUT_TIME: { min: 0 } // Value
407 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
408 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
409 CLIENT_META: { min: 1, max: 5000 }, // Length
410 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
414 const VIEW_LIFETIME = {
415 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
416 VIEWER_COUNTER: 60000 * 2, // 2 minutes
417 VIEWER_STATS: 60000 * 60 // 1 hour
420 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
422 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
424 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
426 STANDARD: [ 24, 25, 30 ],
427 HD_STANDARD: [ 50, 60 ],
431 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
434 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
436 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
441 const FFMPEG_NICE: { [ id: string ]: number } = {
442 // parent process defaults to niceness = 0
443 // reminder: lower = higher priority, max value is 19, lowest is -20
444 LIVE: 5, // prioritize over VOD and THUMBNAIL
449 const VIDEO_CATEGORIES = {
460 11: 'News & Politics',
464 15: 'Science & Technology',
470 // See https://creativecommons.org/licenses/?lang=en
471 const VIDEO_LICENCES = {
473 2: 'Attribution - Share Alike',
474 3: 'Attribution - No Derivatives',
475 4: 'Attribution - Non Commercial',
476 5: 'Attribution - Non Commercial - Share Alike',
477 6: 'Attribution - Non Commercial - No Derivatives',
478 7: 'Public Domain Dedication'
481 const VIDEO_LANGUAGES: { [id: string]: string } = {}
483 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
484 [VideoPrivacy.PUBLIC]: 'Public',
485 [VideoPrivacy.UNLISTED]: 'Unlisted',
486 [VideoPrivacy.PRIVATE]: 'Private',
487 [VideoPrivacy.INTERNAL]: 'Internal'
490 const VIDEO_STATES: { [ id in VideoState ]: string } = {
491 [VideoState.PUBLISHED]: 'Published',
492 [VideoState.TO_TRANSCODE]: 'To transcode',
493 [VideoState.TO_IMPORT]: 'To import',
494 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
495 [VideoState.LIVE_ENDED]: 'Livestream ended',
496 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
497 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
498 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
499 [VideoState.TO_EDIT]: 'To edit*'
502 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
503 [VideoImportState.FAILED]: 'Failed',
504 [VideoImportState.PENDING]: 'Pending',
505 [VideoImportState.SUCCESS]: 'Success',
506 [VideoImportState.REJECTED]: 'Rejected',
507 [VideoImportState.CANCELLED]: 'Cancelled',
508 [VideoImportState.PROCESSING]: 'Processing'
511 const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
512 [VideoChannelSyncState.FAILED]: 'Failed',
513 [VideoChannelSyncState.SYNCED]: 'Synchronized',
514 [VideoChannelSyncState.PROCESSING]: 'Processing',
515 [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
518 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
519 [AbuseState.PENDING]: 'Pending',
520 [AbuseState.REJECTED]: 'Rejected',
521 [AbuseState.ACCEPTED]: 'Accepted'
524 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
525 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
526 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
527 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
530 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
531 [VideoPlaylistType.REGULAR]: 'Regular',
532 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
538 'audio/mpeg': '.mp3',
541 'application/ogg': '.ogg',
544 'audio/x-ms-wma': '.wma',
546 'audio/x-wav': '.wav',
548 'audio/x-flac': '.flac',
549 'audio/flac': '.flac',
551 'audio/vnd.dlna.adts': '.aac',
556 'audio/x-m4a': '.m4a',
558 'audio/vnd.dolby.dd-raw': '.ac3',
561 EXT_MIMETYPE: null as { [ id: string ]: string }
564 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
565 MIMETYPES_REGEX: null as string,
566 EXT_MIMETYPE: null as { [ id: string ]: string }
572 'image/webp': '.webp',
576 EXT_MIMETYPE: null as { [ id: string ]: string }
581 'application/x-subrip': '.srt',
587 'application/x-bittorrent': '.torrent'
591 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
592 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
594 const BINARY_CONTENT_TYPES = new Set([
595 'binary/octet-stream',
596 'application/octet-stream',
597 'application/x-binary'
600 // ---------------------------------------------------------------------------
609 // ---------------------------------------------------------------------------
611 const SERVER_ACTOR_NAME = 'peertube'
613 const ACTIVITY_PUB = {
614 POTENTIAL_ACCEPT_HEADERS: [
615 'application/activity+json',
616 'application/ld+json',
617 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
619 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
620 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
621 COLLECTION_ITEMS_PER_PAGE: 10,
622 FETCH_PAGE_LIMIT: 2000,
624 VIDEO: [] as string[],
625 TORRENT: [ 'application/x-bittorrent' ],
626 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
628 MAX_RECURSION_COMMENTS: 100,
629 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
630 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
631 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
634 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
637 APPLICATION: 'Application',
638 ORGANIZATION: 'Organization',
642 const HTTP_SIGNATURE = {
643 HEADER_NAME: 'signature',
644 ALGORITHM: 'rsa-sha256',
645 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
646 CLOCK_SKEW_SECONDS: 1800
649 // ---------------------------------------------------------------------------
651 let PRIVATE_RSA_KEY_SIZE = 2048
653 // Password encryption
654 const BCRYPT_SALT_SIZE = 10
657 ALGORITHM: 'aes-256-cbc',
660 ENCODING: 'hex' as Encoding
663 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
664 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
666 const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
668 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
670 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
671 DO_NOT_LIST: 'do_not_list',
676 // ---------------------------------------------------------------------------
678 // Express static paths (router)
679 const STATIC_PATHS = {
680 THUMBNAILS: '/static/thumbnails/',
682 WEBSEED: '/static/webseed/',
683 PRIVATE_WEBSEED: '/static/webseed/private/',
685 REDUNDANCY: '/static/redundancy/',
687 STREAMING_PLAYLISTS: {
688 HLS: '/static/streaming-playlists/hls',
689 PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
692 const STATIC_DOWNLOAD_PATHS = {
693 TORRENTS: '/download/torrents/',
694 VIDEOS: '/download/videos/',
695 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
697 const LAZY_STATIC_PATHS = {
698 BANNERS: '/lazy-static/banners/',
699 AVATARS: '/lazy-static/avatars/',
700 PREVIEWS: '/lazy-static/previews/',
701 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
702 TORRENTS: '/lazy-static/torrents/'
704 const OBJECT_STORAGE_PROXY_PATHS = {
705 PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
707 STREAMING_PLAYLISTS: {
708 PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
713 const STATIC_MAX_AGE = {
719 // Videos thumbnail size
720 const THUMBNAILS_SIZE = {
725 const PREVIEWS_SIZE = {
730 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
731 [ActorImageType.AVATAR]: [
741 [ActorImageType.BANNER]: [
744 height: 317 // 6/1 ratio
754 // Sub folders of cache directory
755 const FILES_CACHE = {
757 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
758 MAX_AGE: 1000 * 3600 * 3 // 3 hours
761 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
762 MAX_AGE: 1000 * 3600 * 3 // 3 hours
765 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
766 MAX_AGE: 1000 * 3600 * 3 // 3 hours
774 ACTOR_IMAGE_STATIC: {
777 STATIC_VIDEO_FILES_RIGHTS_CHECK: {
779 TTL: parseDurationToMs('10 seconds')
783 TTL: parseDurationToMs('8 hours')
787 const DIRECTORIES = {
788 RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
790 HLS_STREAMING_PLAYLIST: {
791 PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
792 PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
796 PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
797 PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
800 HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
803 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
807 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
808 SEGMENT_TIME_SECONDS: {
809 DEFAULT_LATENCY: 4, // 4 seconds
810 SMALL_LATENCY: 2 // 2 seconds
812 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
813 REPLAY_DIRECTORY: 'replay',
814 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
815 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
825 const MEMOIZE_TTL = {
826 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
827 INFO_HASH_EXISTS: 1000 * 60, // 1 minute
828 VIDEO_DURATION: 1000 * 10, // 10 seconds
829 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
830 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
831 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
834 const MEMOIZE_LENGTH = {
835 INFO_HASH_EXISTS: 200,
839 const WORKER_THREADS = {
856 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
858 HEADER_NAME: 'x-peertube-otp',
859 HEADER_REQUIRED_VALUE: 'required; app'
862 const ASSETS_PATH = {
863 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
864 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
867 // ---------------------------------------------------------------------------
869 const CUSTOM_HTML_TAG_COMMENTS = {
870 TITLE: '<!-- title tag -->',
871 DESCRIPTION: '<!-- description tag -->',
872 CUSTOM_CSS: '<!-- custom css tag -->',
873 META_TAGS: '<!-- meta tags -->',
874 SERVER_CONFIG: '<!-- server config -->'
877 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
878 const LOG_FILENAME = 'peertube.log'
879 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
881 // ---------------------------------------------------------------------------
883 const TRACKER_RATE_LIMITS = {
884 INTERVAL: 60000 * 5, // 5 minutes
885 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
886 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
887 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
890 const P2P_MEDIA_LOADER_PEER_VERSION = 2
892 // ---------------------------------------------------------------------------
894 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
895 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
897 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
899 const DEFAULT_THEME_NAME = 'default'
900 const DEFAULT_USER_THEME_NAME = 'instance-default'
902 // ---------------------------------------------------------------------------
904 const SEARCH_INDEX = {
906 VIDEOS: '/api/v1/search/videos',
907 VIDEO_CHANNELS: '/api/v1/search/video-channels'
911 // ---------------------------------------------------------------------------
913 const STATS_TIMESERIE = {
914 MAX_DAYS: 365 * 10 // Around 10 years
917 // ---------------------------------------------------------------------------
919 // Special constants for a test instance
920 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
921 if (isTestOrDevInstance()) {
922 PRIVATE_RSA_KEY_SIZE = 1024
924 ACTOR_FOLLOW_SCORE.BASE = 20
926 REMOTE_SCHEME.HTTP = 'http'
927 REMOTE_SCHEME.WS = 'ws'
929 STATIC_MAX_AGE.SERVER = '0'
931 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
932 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
933 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
934 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
935 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
936 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
937 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
938 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
940 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
942 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
943 AP_CLEANER.PERIOD = 5000
945 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
947 CONTACT_FORM_LIFETIME = 1000 // 1 second
949 JOB_ATTEMPTS['email'] = 1
951 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
952 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
953 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
954 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
956 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
958 JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
961 if (isTestInstance()) {
962 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
963 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
964 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
965 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
967 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
968 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
970 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
971 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
973 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
974 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
975 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
976 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
980 updateWebserverUrls()
981 updateWebserverConfig()
983 registerConfigChangedHandler(() => {
984 updateWebserverUrls()
985 updateWebserverConfig()
988 // ---------------------------------------------------------------------------
990 const FILES_CONTENT_HASH = {
991 MANIFEST: generateContentHash(),
992 FAVICON: generateContentHash(),
993 LOGO: generateContentHash()
996 // ---------------------------------------------------------------------------
998 const VIDEO_FILTERS = {
1001 HORIZONTAL_MARGIN_RATIO: 1 / 20,
1002 VERTICAL_MARGIN_RATIO: 1 / 20
1006 // ---------------------------------------------------------------------------
1015 OBJECT_STORAGE_PROXY_PATHS,
1018 RESUMABLE_UPLOAD_SESSION_LIFETIME,
1019 P2P_MEDIA_LOADER_PEER_VERSION,
1023 TRACKER_RATE_LIMITS,
1032 LAST_MIGRATION_VERSION,
1034 CUSTOM_HTML_TAG_COMMENTS,
1036 BROADCAST_CONCURRENCY,
1043 DEFAULT_USER_THEME_NAME,
1045 TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
1046 PLUGIN_GLOBAL_CSS_FILE_NAME,
1047 PLUGIN_GLOBAL_CSS_PATH,
1048 PRIVATE_RSA_KEY_SIZE,
1050 ROUTE_CACHE_LIFETIME,
1057 VIDEO_IMPORT_TIMEOUT,
1058 VIDEO_PLAYLIST_TYPES,
1059 MAX_LOGS_OUTPUT_CHARACTERS,
1061 ACTIVITY_PUB_ACTOR_TYPES,
1072 VIDEO_TRANSCODING_FPS,
1077 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
1078 USER_PASSWORD_RESET_LIFETIME,
1079 USER_PASSWORD_CREATE_LIFETIME,
1081 USER_EMAIL_VERIFY_LIFETIME,
1083 SCHEDULER_INTERVALS_MS,
1085 STATIC_DOWNLOAD_PATHS,
1087 CRAWL_REQUEST_CONCURRENCY,
1088 DEFAULT_AUDIO_RESOLUTION,
1089 BINARY_CONTENT_TYPES,
1090 JOB_REMOVAL_OPTIONS,
1092 VIDEO_IMPORT_STATES,
1093 VIDEO_CHANNEL_SYNC_STATE,
1095 CONTACT_FORM_LIFETIME,
1096 VIDEO_PLAYLIST_PRIVACIES,
1097 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1106 // ---------------------------------------------------------------------------
1108 function buildVideoMimetypeExt () {
1110 // streamable formats that warrant cross-browser compatibility
1111 'video/webm': '.webm',
1112 // We'll add .ogg if additional extensions are enabled
1113 // We could add .ogg here but since it could be an audio file,
1114 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1115 'video/ogg': [ '.ogv' ],
1119 if (CONFIG.TRANSCODING.ENABLED) {
1120 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1121 data['video/ogg'].push('.ogg')
1123 Object.assign(data, {
1124 'video/x-matroska': '.mkv',
1126 // Developed by Apple
1127 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1128 'video/x-m4v': '.m4v',
1129 'video/m4v': '.m4v',
1131 // Developed by the Adobe Flash Platform
1132 'video/x-flv': '.flv',
1133 'video/x-f4v': '.f4v', // replacement for flv
1135 // Developed by Microsoft
1136 'video/x-ms-wmv': '.wmv',
1137 'video/x-msvideo': '.avi',
1138 'video/avi': '.avi',
1140 // Developed by 3GPP
1141 // common video formats for cell phones
1142 'video/3gpp': [ '.3gp', '.3gpp' ],
1143 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1145 // Developed by FFmpeg/Mplayer
1146 'application/x-nut': '.nut',
1148 // The standard video format used by many Sony and Panasonic HD camcorders.
1149 // It is also used for storing high definition video on Blu-ray discs.
1150 'video/mp2t': '.mts',
1151 'video/vnd.dlna.mpeg-tts': '.mts',
1153 'video/m2ts': '.m2ts',
1155 // Old formats reliant on MPEG-1/MPEG-2
1156 'video/mpv': '.mpv',
1157 'video/mpeg2': '.m2v',
1158 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1159 'video/dvd': '.vob',
1161 // Could be anything
1162 'application/octet-stream': null,
1163 'application/mxf': '.mxf' // often used as exchange format by editing software
1167 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1168 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1175 function updateWebserverUrls () {
1176 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1177 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1178 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1180 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1181 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1182 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1184 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1185 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1187 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1188 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1191 function updateWebserverConfig () {
1192 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1193 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1195 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1197 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1199 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1202 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1203 const result: { [id: string]: string } = {}
1205 for (const mimetype of Object.keys(obj)) {
1206 const value = obj[mimetype]
1207 if (!value) continue
1209 const extensions = Array.isArray(value) ? value : [ value ]
1211 for (const extension of extensions) {
1212 result[extension] = mimetype
1219 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1220 return Object.keys(obj)
1225 function loadLanguages () {
1226 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1229 function buildLanguages () {
1230 const iso639 = require('iso-639-3')
1232 const languages: { [id: string]: string } = {}
1234 const additionalLanguages = {
1235 sgn: true, // Sign languages (macro language)
1236 ase: true, // American sign language
1237 sdl: true, // Arabian sign language
1238 bfi: true, // British sign language
1239 bzs: true, // Brazilian sign language
1240 csl: true, // Chinese sign language
1241 cse: true, // Czech sign language
1242 dsl: true, // Danish sign language
1243 fsl: true, // French sign language
1244 gsg: true, // German sign language
1245 pks: true, // Pakistan sign language
1246 jsl: true, // Japanese sign language
1247 sfs: true, // South African sign language
1248 swl: true, // Swedish sign language
1249 rsl: true, // Russian sign language
1251 kab: true, // Kabyle
1255 epo: true, // Esperanto
1256 tlh: true, // Klingon
1257 jbo: true, // Lojban
1258 avk: true, // Kotava
1260 zxx: true // No linguistic content (ISO-639-2)
1263 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1266 return (l.iso6391 !== undefined && l.type === 'living') ||
1267 additionalLanguages[l.iso6393] === true
1269 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1271 // Override Occitan label
1272 languages['oc'] = 'Occitan'
1273 languages['el'] = 'Greek'
1274 languages['tok'] = 'Toki Pona'
1276 // Chinese languages
1277 languages['zh-Hans'] = 'Simplified Chinese'
1278 languages['zh-Hant'] = 'Traditional Chinese'
1283 function generateContentHash () {
1284 return randomBytes(20).toString('hex')
1287 function getIntEnv (path: string) {
1288 if (process.env[path]) return parseInt(process.env[path])