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 UserRegistrationState,
11 VideoChannelSyncState,
18 } from '../../shared/models'
19 import { ActivityPubActorType } from '../../shared/models/activitypub'
20 import { ActorImageType, FollowState } from '../../shared/models/actors'
21 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
22 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
23 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
24 // Do not use barrels, remain constants as independent as possible
25 import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
26 import { CONFIG, registerConfigChangedHandler } from './config'
28 // ---------------------------------------------------------------------------
30 const LAST_MIGRATION_VERSION = 765
32 // ---------------------------------------------------------------------------
34 const API_VERSION = 'v1'
35 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
62 // Sortable columns per schema
63 const SORTABLE_COLUMNS = {
64 ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
65 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
66 ACCOUNTS: [ 'createdAt' ],
67 JOBS: [ 'createdAt' ],
68 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
69 VIDEO_IMPORTS: [ 'createdAt' ],
70 VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
72 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
73 VIDEO_COMMENTS: [ 'createdAt' ],
75 VIDEO_RATES: [ 'createdAt' ],
76 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
78 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
79 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
80 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
81 CHANNEL_FOLLOWERS: [ 'createdAt' ],
83 USER_REGISTRATIONS: [ 'createdAt', 'state' ],
85 RUNNERS: [ 'createdAt' ],
86 RUNNER_REGISTRATION_TOKENS: [ 'createdAt' ],
87 RUNNER_JOBS: [ 'updatedAt', 'createdAt', 'priority', 'state', 'progress' ],
89 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
91 // Don't forget to update peertube-search-index with the same values
92 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
93 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
94 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
96 ABUSES: [ 'id', 'createdAt', 'state' ],
98 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
99 SERVERS_BLOCKLIST: [ 'createdAt' ],
101 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
103 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
105 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
107 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
109 VIDEO_REDUNDANCIES: [ 'name' ]
112 const ROUTE_CACHE_LIFETIME = {
116 SECURITYTXT: '2 hours',
117 NODEINFO: '10 minutes',
118 DNT_POLICY: '1 week',
120 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
126 // ---------------------------------------------------------------------------
128 // Number of points we add/remove after a successful/bad request
129 const ACTOR_FOLLOW_SCORE = {
136 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
138 ACCEPTED: 'accepted',
142 const REMOTE_SCHEME = {
147 // ---------------------------------------------------------------------------
149 const JOB_ATTEMPTS: { [id in JobType]: number } = {
150 'activitypub-http-broadcast': 1,
151 'activitypub-http-broadcast-parallel': 1,
152 'activitypub-http-unicast': 1,
153 'activitypub-http-fetcher': 2,
154 'activitypub-follow': 5,
155 'activitypub-cleaner': 1,
156 'video-file-import': 1,
157 'video-transcoding': 1,
161 'videos-views-stats': 1,
162 'activitypub-refresher': 1,
163 'video-redundancy': 1,
164 'video-live-ending': 1,
165 'video-studio-edition': 1,
166 'manage-video-torrent': 1,
167 'video-channel-import': 1,
168 'after-video-channel-import': 1,
169 'move-to-object-storage': 3,
170 'transcoding-job-builder': 1,
174 // Excluded keys are jobs that can be configured by admins
175 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
176 'activitypub-http-broadcast': 1,
177 'activitypub-http-broadcast-parallel': 30,
178 'activitypub-http-unicast': 30,
179 'activitypub-http-fetcher': 3,
180 'activitypub-cleaner': 1,
181 'activitypub-follow': 1,
182 'video-file-import': 1,
185 'videos-views-stats': 1,
186 'activitypub-refresher': 1,
187 'video-redundancy': 1,
188 'video-live-ending': 10,
189 'video-studio-edition': 1,
190 'manage-video-torrent': 1,
191 'move-to-object-storage': 1,
192 'video-channel-import': 1,
193 'after-video-channel-import': 1,
194 'transcoding-job-builder': 1,
198 const JOB_TTL: { [id in JobType]: number } = {
199 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
200 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
201 'activitypub-http-unicast': 60000 * 10, // 10 minutes
202 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
203 'activitypub-follow': 60000 * 10, // 10 minutes
204 'activitypub-cleaner': 1000 * 3600, // 1 hour
205 'video-file-import': 1000 * 3600, // 1 hour
206 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
207 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
208 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
209 'email': 60000 * 10, // 10 minutes
210 'actor-keys': 60000 * 20, // 20 minutes
211 'videos-views-stats': undefined, // Unlimited
212 'activitypub-refresher': 60000 * 10, // 10 minutes
213 'video-redundancy': 1000 * 3600 * 3, // 3 hours
214 'video-live-ending': 1000 * 60 * 10, // 10 minutes
215 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
216 'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
217 'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
218 'after-video-channel-import': 60000 * 5, // 5 minutes
219 'transcoding-job-builder': 60000, // 1 minute
220 'notify': 60000 * 5, // 5 minutes
221 'federate-video': 60000 * 5 // 5 minutes
223 const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
224 'videos-views-stats': {
225 pattern: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
227 'activitypub-cleaner': {
228 pattern: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
231 const JOB_PRIORITY = {
236 const JOB_REMOVAL_OPTIONS = {
237 COUNT: 10000, // Max jobs to store
239 SUCCESS: { // Success jobs
240 'DEFAULT': parseDurationToMs('2 days'),
242 'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
243 'activitypub-http-unicast': parseDurationToMs('1 hour'),
244 'videos-views-stats': parseDurationToMs('3 hours'),
245 'activitypub-refresher': parseDurationToMs('10 hours')
248 FAILURE: { // Failed job
249 DEFAULT: parseDurationToMs('7 days')
253 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
255 const RUNNER_JOBS = {
259 // ---------------------------------------------------------------------------
261 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
262 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
265 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
266 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
267 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
270 const REQUEST_TIMEOUTS = {
271 DEFAULT: 7000, // 7 seconds
272 FILE: 30000, // 30 seconds
273 REDUNDANCY: JOB_TTL['video-redundancy']
276 const SCHEDULER_INTERVALS_MS = {
277 RUNNER_JOB_WATCH_DOG: Math.min(CONFIG.REMOTE_RUNNERS.STALLED_JOBS.VOD, CONFIG.REMOTE_RUNNERS.STALLED_JOBS.LIVE),
278 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
279 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
280 UPDATE_VIDEOS: 60000, // 1 minute
281 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
282 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
283 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
284 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
285 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
286 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
287 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
288 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
289 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
290 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
291 CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
294 // ---------------------------------------------------------------------------
296 const CONSTRAINTS_FIELDS = {
298 NAME: { min: 1, max: 120 }, // Length
299 DESCRIPTION: { min: 3, max: 1000 }, // Length
300 USERNAME: { min: 1, max: 50 }, // Length
301 PASSWORD: { min: 6, max: 255 }, // Length
302 VIDEO_QUOTA: { min: -1 },
303 VIDEO_QUOTA_DAILY: { min: -1 },
304 VIDEO_LANGUAGES: { max: 500 }, // Array length
305 BLOCKED_REASON: { min: 3, max: 250 } // Length
308 REASON: { min: 2, max: 3000 }, // Length
309 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
312 MESSAGE: { min: 2, max: 3000 } // Length
314 USER_REGISTRATIONS: {
315 REASON_MESSAGE: { min: 2, max: 3000 }, // Length
316 MODERATOR_MESSAGE: { min: 2, max: 3000 } // Length
319 REASON: { min: 2, max: 300 } // Length
322 NAME: { min: 1, max: 120 }, // Length
323 DESCRIPTION: { min: 3, max: 1000 }, // Length
324 SUPPORT: { min: 3, max: 1000 }, // Length
325 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
326 URL: { min: 3, max: 2000 } // Length
328 VIDEO_CHANNEL_SYNCS: {
329 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
333 EXTNAME: [ '.vtt', '.srt' ],
335 max: 20 * 1024 * 1024 // 20MB
340 URL: { min: 3, max: 2000 }, // Length
341 TORRENT_NAME: { min: 3, max: 255 }, // Length
343 EXTNAME: [ '.torrent' ],
345 max: 1024 * 200 // 200 KB
350 URL: { min: 3, max: 2000 } // Length
353 URL: { min: 3, max: 2000 } // Length
356 NAME: { min: 3, max: 120 }, // Length
357 LANGUAGE: { min: 1, max: 10 }, // Length
358 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
359 DESCRIPTION: { min: 3, max: 10000 }, // Length
360 SUPPORT: { min: 3, max: 1000 }, // Length
362 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
364 max: 4 * 1024 * 1024 // 4MB
367 EXTNAME: [] as string[],
368 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
369 DURATION: { min: 0 }, // Number
370 TAGS: { min: 0, max: 5 }, // Number of total tags
371 TAG: { min: 2, max: 30 }, // Length
374 DISLIKES: { min: 0 },
375 FILE_SIZE: { min: -1 },
376 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
377 URL: { min: 3, max: 2000 } // Length
380 NAME: { min: 1, max: 120 }, // Length
381 DESCRIPTION: { min: 3, max: 1000 }, // Length
382 URL: { min: 3, max: 2000 }, // Length
384 EXTNAME: [ '.jpg', '.jpeg' ],
386 max: 4 * 1024 * 1024 // 4MB
391 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
392 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
393 URL: { min: 3, max: 2000 }, // Length
395 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
397 max: 4 * 1024 * 1024 // 4MB
405 TEXT: { min: 1, max: 10000 }, // Length
406 URL: { min: 3, max: 2000 } // Length
409 URL: { min: 3, max: 2000 } // Length
412 FROM_NAME: { min: 1, max: 120 }, // Length
413 BODY: { min: 3, max: 5000 } // Length
416 NAME: { min: 1, max: 214 }, // Length
417 DESCRIPTION: { min: 1, max: 20000 } // Length
420 URL: { min: 5, max: 2000 } // Length
423 TASKS: { min: 1, max: 10 }, // Number of tasks
424 CUT_TIME: { min: 0 } // Value
427 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
428 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
429 CLIENT_META: { min: 1, max: 5000 }, // Length
430 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
433 TOKEN: { min: 1, max: 1000 }, // Length
434 NAME: { min: 1, max: 100 }, // Length
435 DESCRIPTION: { min: 1, max: 1000 } // Length
438 TOKEN: { min: 1, max: 1000 }, // Length
439 REASON: { min: 1, max: 5000 }, // Length
440 ERROR_MESSAGE: { min: 1, max: 5000 }, // Length
441 PROGRESS: { min: 0, max: 100 } // Value
445 const VIEW_LIFETIME = {
446 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
447 VIEWER_COUNTER: 60000 * 2, // 2 minutes
448 VIEWER_STATS: 60000 * 60 // 1 hour
451 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
453 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
455 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
457 STANDARD: [ 24, 25, 30 ],
458 HD_STANDARD: [ 50, 60 ],
462 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
465 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
467 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
472 const FFMPEG_NICE = {
473 // parent process defaults to niceness = 0
474 // reminder: lower = higher priority, max value is 19, lowest is -20
475 LIVE: 5, // prioritize over VOD and THUMBNAIL
480 const VIDEO_CATEGORIES = {
491 11: 'News & Politics',
495 15: 'Science & Technology',
501 // See https://creativecommons.org/licenses/?lang=en
502 const VIDEO_LICENCES = {
504 2: 'Attribution - Share Alike',
505 3: 'Attribution - No Derivatives',
506 4: 'Attribution - Non Commercial',
507 5: 'Attribution - Non Commercial - Share Alike',
508 6: 'Attribution - Non Commercial - No Derivatives',
509 7: 'Public Domain Dedication'
512 const VIDEO_LANGUAGES: { [id: string]: string } = {}
514 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
515 [VideoPrivacy.PUBLIC]: 'Public',
516 [VideoPrivacy.UNLISTED]: 'Unlisted',
517 [VideoPrivacy.PRIVATE]: 'Private',
518 [VideoPrivacy.INTERNAL]: 'Internal'
521 const VIDEO_STATES: { [ id in VideoState ]: string } = {
522 [VideoState.PUBLISHED]: 'Published',
523 [VideoState.TO_TRANSCODE]: 'To transcode',
524 [VideoState.TO_IMPORT]: 'To import',
525 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
526 [VideoState.LIVE_ENDED]: 'Livestream ended',
527 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
528 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
529 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
530 [VideoState.TO_EDIT]: 'To edit*'
533 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
534 [VideoImportState.FAILED]: 'Failed',
535 [VideoImportState.PENDING]: 'Pending',
536 [VideoImportState.SUCCESS]: 'Success',
537 [VideoImportState.REJECTED]: 'Rejected',
538 [VideoImportState.CANCELLED]: 'Cancelled',
539 [VideoImportState.PROCESSING]: 'Processing'
542 const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
543 [VideoChannelSyncState.FAILED]: 'Failed',
544 [VideoChannelSyncState.SYNCED]: 'Synchronized',
545 [VideoChannelSyncState.PROCESSING]: 'Processing',
546 [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
549 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
550 [AbuseState.PENDING]: 'Pending',
551 [AbuseState.REJECTED]: 'Rejected',
552 [AbuseState.ACCEPTED]: 'Accepted'
555 const USER_REGISTRATION_STATES: { [ id in UserRegistrationState ]: string } = {
556 [UserRegistrationState.PENDING]: 'Pending',
557 [UserRegistrationState.REJECTED]: 'Rejected',
558 [UserRegistrationState.ACCEPTED]: 'Accepted'
561 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
562 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
563 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
564 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
567 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
568 [VideoPlaylistType.REGULAR]: 'Regular',
569 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
572 const RUNNER_JOB_STATES: { [ id in RunnerJobState ]: string } = {
573 [RunnerJobState.PROCESSING]: 'Processing',
574 [RunnerJobState.COMPLETED]: 'Completed',
575 [RunnerJobState.PENDING]: 'Pending',
576 [RunnerJobState.ERRORED]: 'Errored',
577 [RunnerJobState.WAITING_FOR_PARENT_JOB]: 'Waiting for parent job to finish',
578 [RunnerJobState.CANCELLED]: 'Cancelled',
579 [RunnerJobState.PARENT_ERRORED]: 'Parent job failed',
580 [RunnerJobState.PARENT_CANCELLED]: 'Parent job cancelled'
586 'audio/mpeg': '.mp3',
589 'application/ogg': '.ogg',
592 'audio/x-ms-wma': '.wma',
594 'audio/x-wav': '.wav',
596 'audio/x-flac': '.flac',
597 'audio/flac': '.flac',
599 'audio/vnd.dlna.adts': '.aac',
604 'audio/x-m4a': '.m4a',
606 'audio/vnd.dolby.dd-raw': '.ac3',
609 EXT_MIMETYPE: null as { [ id: string ]: string }
612 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
613 MIMETYPES_REGEX: null as string,
614 EXT_MIMETYPE: null as { [ id: string ]: string }
620 'image/webp': '.webp',
624 EXT_MIMETYPE: null as { [ id: string ]: string }
629 'application/x-subrip': '.srt',
635 'application/x-bittorrent': '.torrent'
640 'application/vnd.apple.mpegurl': '.m3u8'
644 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
645 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
647 const BINARY_CONTENT_TYPES = new Set([
648 'binary/octet-stream',
649 'application/octet-stream',
650 'application/x-binary'
653 // ---------------------------------------------------------------------------
662 // ---------------------------------------------------------------------------
664 const SERVER_ACTOR_NAME = 'peertube'
666 const ACTIVITY_PUB = {
667 POTENTIAL_ACCEPT_HEADERS: [
668 'application/activity+json',
669 'application/ld+json',
670 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
672 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
673 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
674 COLLECTION_ITEMS_PER_PAGE: 10,
675 FETCH_PAGE_LIMIT: 2000,
677 VIDEO: [] as string[],
678 TORRENT: [ 'application/x-bittorrent' ],
679 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
681 MAX_RECURSION_COMMENTS: 100,
682 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
683 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
684 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
687 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
690 APPLICATION: 'Application',
691 ORGANIZATION: 'Organization',
695 const HTTP_SIGNATURE = {
696 HEADER_NAME: 'signature',
697 ALGORITHM: 'rsa-sha256',
698 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
699 CLOCK_SKEW_SECONDS: 1800
702 // ---------------------------------------------------------------------------
704 let PRIVATE_RSA_KEY_SIZE = 2048
706 // Password encryption
707 const BCRYPT_SALT_SIZE = 10
710 ALGORITHM: 'aes-256-cbc',
713 ENCODING: 'hex' as Encoding
716 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
717 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
719 const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
721 const EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
723 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
724 DO_NOT_LIST: 'do_not_list',
729 // ---------------------------------------------------------------------------
731 // Express static paths (router)
732 const STATIC_PATHS = {
733 THUMBNAILS: '/static/thumbnails/',
735 WEBSEED: '/static/webseed/',
736 PRIVATE_WEBSEED: '/static/webseed/private/',
738 REDUNDANCY: '/static/redundancy/',
740 STREAMING_PLAYLISTS: {
741 HLS: '/static/streaming-playlists/hls',
742 PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
745 const STATIC_DOWNLOAD_PATHS = {
746 TORRENTS: '/download/torrents/',
747 VIDEOS: '/download/videos/',
748 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
750 const LAZY_STATIC_PATHS = {
751 BANNERS: '/lazy-static/banners/',
752 AVATARS: '/lazy-static/avatars/',
753 PREVIEWS: '/lazy-static/previews/',
754 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
755 TORRENTS: '/lazy-static/torrents/'
757 const OBJECT_STORAGE_PROXY_PATHS = {
758 PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
760 STREAMING_PLAYLISTS: {
761 PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
766 const STATIC_MAX_AGE = {
772 // Videos thumbnail size
773 const THUMBNAILS_SIZE = {
778 const PREVIEWS_SIZE = {
783 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
784 [ActorImageType.AVATAR]: [
794 [ActorImageType.BANNER]: [
797 height: 317 // 6/1 ratio
807 // Sub folders of cache directory
808 const FILES_CACHE = {
810 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
811 MAX_AGE: 1000 * 3600 * 3 // 3 hours
814 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
815 MAX_AGE: 1000 * 3600 * 3 // 3 hours
818 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
819 MAX_AGE: 1000 * 3600 * 3 // 3 hours
827 ACTOR_IMAGE_STATIC: {
830 STATIC_VIDEO_FILES_RIGHTS_CHECK: {
832 TTL: parseDurationToMs('10 seconds')
836 TTL: parseDurationToMs('8 hours')
843 const DIRECTORIES = {
844 RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
846 HLS_STREAMING_PLAYLIST: {
847 PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
848 PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
852 PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
853 PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
856 HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
859 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
863 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
864 SEGMENT_TIME_SECONDS: {
865 DEFAULT_LATENCY: 4, // 4 seconds
866 SMALL_LATENCY: 2 // 2 seconds
868 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
869 REPLAY_DIRECTORY: 'replay',
870 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
871 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
881 const MEMOIZE_TTL = {
882 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
883 INFO_HASH_EXISTS: 1000 * 60, // 1 minute
884 VIDEO_DURATION: 1000 * 10, // 10 seconds
885 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
886 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
887 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
890 const MEMOIZE_LENGTH = {
891 INFO_HASH_EXISTS: 200,
895 const WORKER_THREADS = {
912 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
914 HEADER_NAME: 'x-peertube-otp',
915 HEADER_REQUIRED_VALUE: 'required; app'
918 const ASSETS_PATH = {
919 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
920 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
923 // ---------------------------------------------------------------------------
925 const CUSTOM_HTML_TAG_COMMENTS = {
926 TITLE: '<!-- title tag -->',
927 DESCRIPTION: '<!-- description tag -->',
928 CUSTOM_CSS: '<!-- custom css tag -->',
929 META_TAGS: '<!-- meta tags -->',
930 SERVER_CONFIG: '<!-- server config -->'
933 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
934 const LOG_FILENAME = 'peertube.log'
935 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
937 // ---------------------------------------------------------------------------
939 const TRACKER_RATE_LIMITS = {
940 INTERVAL: 60000 * 5, // 5 minutes
941 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
942 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
943 BLOCK_IP_LIFETIME: parseDurationToMs('3 minutes')
946 const P2P_MEDIA_LOADER_PEER_VERSION = 2
948 // ---------------------------------------------------------------------------
950 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
951 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
953 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
955 const DEFAULT_THEME_NAME = 'default'
956 const DEFAULT_USER_THEME_NAME = 'instance-default'
958 // ---------------------------------------------------------------------------
960 const SEARCH_INDEX = {
962 VIDEOS: '/api/v1/search/videos',
963 VIDEO_CHANNELS: '/api/v1/search/video-channels'
967 // ---------------------------------------------------------------------------
969 const STATS_TIMESERIE = {
970 MAX_DAYS: 365 * 10 // Around 10 years
973 // ---------------------------------------------------------------------------
975 // Special constants for a test instance
976 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
977 if (isTestOrDevInstance()) {
978 PRIVATE_RSA_KEY_SIZE = 1024
980 ACTOR_FOLLOW_SCORE.BASE = 20
982 REMOTE_SCHEME.HTTP = 'http'
983 REMOTE_SCHEME.WS = 'ws'
985 STATIC_MAX_AGE.SERVER = '0'
987 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
988 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
989 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
990 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
991 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
992 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
993 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
994 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
996 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
998 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
999 AP_CLEANER.PERIOD = 5000
1001 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
1003 CONTACT_FORM_LIFETIME = 1000 // 1 second
1005 JOB_ATTEMPTS['email'] = 1
1007 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
1008 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
1009 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
1010 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
1012 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
1014 JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
1017 if (isTestInstance()) {
1018 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
1019 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1020 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1021 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1023 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
1024 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
1026 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
1027 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
1029 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
1030 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
1031 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
1032 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
1036 updateWebserverUrls()
1037 updateWebserverConfig()
1039 registerConfigChangedHandler(() => {
1040 updateWebserverUrls()
1041 updateWebserverConfig()
1044 // ---------------------------------------------------------------------------
1046 const FILES_CONTENT_HASH = {
1047 MANIFEST: generateContentHash(),
1048 FAVICON: generateContentHash(),
1049 LOGO: generateContentHash()
1052 // ---------------------------------------------------------------------------
1054 const VIDEO_FILTERS = {
1057 HORIZONTAL_MARGIN_RATIO: 1 / 20,
1058 VERTICAL_MARGIN_RATIO: 1 / 20
1062 // ---------------------------------------------------------------------------
1071 OBJECT_STORAGE_PROXY_PATHS,
1074 RESUMABLE_UPLOAD_SESSION_LIFETIME,
1076 P2P_MEDIA_LOADER_PEER_VERSION,
1080 TRACKER_RATE_LIMITS,
1089 LAST_MIGRATION_VERSION,
1090 CUSTOM_HTML_TAG_COMMENTS,
1092 BROADCAST_CONCURRENCY,
1099 DEFAULT_USER_THEME_NAME,
1101 TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
1102 PLUGIN_GLOBAL_CSS_FILE_NAME,
1103 PLUGIN_GLOBAL_CSS_PATH,
1104 PRIVATE_RSA_KEY_SIZE,
1106 ROUTE_CACHE_LIFETIME,
1113 VIDEO_IMPORT_TIMEOUT,
1114 VIDEO_PLAYLIST_TYPES,
1115 MAX_LOGS_OUTPUT_CHARACTERS,
1117 ACTIVITY_PUB_ACTOR_TYPES,
1128 VIDEO_TRANSCODING_FPS,
1131 USER_REGISTRATION_STATES,
1135 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
1136 USER_PASSWORD_RESET_LIFETIME,
1137 USER_PASSWORD_CREATE_LIFETIME,
1139 EMAIL_VERIFY_LIFETIME,
1141 SCHEDULER_INTERVALS_MS,
1143 STATIC_DOWNLOAD_PATHS,
1145 CRAWL_REQUEST_CONCURRENCY,
1146 DEFAULT_AUDIO_RESOLUTION,
1147 BINARY_CONTENT_TYPES,
1148 JOB_REMOVAL_OPTIONS,
1150 VIDEO_IMPORT_STATES,
1151 VIDEO_CHANNEL_SYNC_STATE,
1153 CONTACT_FORM_LIFETIME,
1154 VIDEO_PLAYLIST_PRIVACIES,
1155 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1164 // ---------------------------------------------------------------------------
1166 function buildVideoMimetypeExt () {
1168 // streamable formats that warrant cross-browser compatibility
1169 'video/webm': '.webm',
1170 // We'll add .ogg if additional extensions are enabled
1171 // We could add .ogg here but since it could be an audio file,
1172 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1173 'video/ogg': [ '.ogv' ],
1177 if (CONFIG.TRANSCODING.ENABLED) {
1178 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1179 data['video/ogg'].push('.ogg')
1181 Object.assign(data, {
1182 'video/x-matroska': '.mkv',
1184 // Developed by Apple
1185 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1186 'video/x-m4v': '.m4v',
1187 'video/m4v': '.m4v',
1189 // Developed by the Adobe Flash Platform
1190 'video/x-flv': '.flv',
1191 'video/x-f4v': '.f4v', // replacement for flv
1193 // Developed by Microsoft
1194 'video/x-ms-wmv': '.wmv',
1195 'video/x-msvideo': '.avi',
1196 'video/avi': '.avi',
1198 // Developed by 3GPP
1199 // common video formats for cell phones
1200 'video/3gpp': [ '.3gp', '.3gpp' ],
1201 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1203 // Developed by FFmpeg/Mplayer
1204 'application/x-nut': '.nut',
1206 // The standard video format used by many Sony and Panasonic HD camcorders.
1207 // It is also used for storing high definition video on Blu-ray discs.
1208 'video/mp2t': '.mts',
1209 'video/vnd.dlna.mpeg-tts': '.mts',
1211 'video/m2ts': '.m2ts',
1213 // Old formats reliant on MPEG-1/MPEG-2
1214 'video/mpv': '.mpv',
1215 'video/mpeg2': '.m2v',
1216 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1217 'video/dvd': '.vob',
1219 // Could be anything
1220 'application/octet-stream': null,
1221 'application/mxf': '.mxf' // often used as exchange format by editing software
1225 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1226 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1233 function updateWebserverUrls () {
1234 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1235 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1236 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1238 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1239 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1240 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1242 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1243 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1245 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1246 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1249 function updateWebserverConfig () {
1250 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1251 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1253 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1255 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1257 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1260 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1261 const result: { [id: string]: string } = {}
1263 for (const mimetype of Object.keys(obj)) {
1264 const value = obj[mimetype]
1265 if (!value) continue
1267 const extensions = Array.isArray(value) ? value : [ value ]
1269 for (const extension of extensions) {
1270 result[extension] = mimetype
1277 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1278 return Object.keys(obj)
1283 function loadLanguages () {
1284 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1287 function buildLanguages () {
1288 const iso639 = require('iso-639-3')
1290 const languages: { [id: string]: string } = {}
1292 const additionalLanguages = {
1293 sgn: true, // Sign languages (macro language)
1294 ase: true, // American sign language
1295 asq: true, // Austrian sign language
1296 sdl: true, // Arabian sign language
1297 bfi: true, // British sign language
1298 bzs: true, // Brazilian sign language
1299 csl: true, // Chinese sign language
1300 cse: true, // Czech sign language
1301 dsl: true, // Danish sign language
1302 fsl: true, // French sign language
1303 gsg: true, // German sign language
1304 pks: true, // Pakistan sign language
1305 jsl: true, // Japanese sign language
1306 sfs: true, // South African sign language
1307 swl: true, // Swedish sign language
1308 rsl: true, // Russian sign language
1310 kab: true, // Kabyle
1314 epo: true, // Esperanto
1315 tlh: true, // Klingon
1316 jbo: true, // Lojban
1317 avk: true, // Kotava
1319 zxx: true // No linguistic content (ISO-639-2)
1322 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1325 return (l.iso6391 !== undefined && l.type === 'living') ||
1326 additionalLanguages[l.iso6393] === true
1328 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1330 // Override Occitan label
1331 languages['oc'] = 'Occitan'
1332 languages['el'] = 'Greek'
1333 languages['tok'] = 'Toki Pona'
1335 // Chinese languages
1336 languages['zh-Hans'] = 'Simplified Chinese'
1337 languages['zh-Hant'] = 'Traditional Chinese'
1342 function generateContentHash () {
1343 return randomBytes(20).toString('hex')
1346 function getIntEnv (path: string) {
1347 if (process.env[path]) return parseInt(process.env[path])