1 import { RepeatOptions } from 'bullmq'
2 import { 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_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
243 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
245 const SCHEDULER_INTERVALS_MS = {
246 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
247 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
248 UPDATE_VIDEOS: 60000, // 1 minute
249 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
250 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
251 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
252 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
253 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
254 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
255 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
256 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
257 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
258 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
259 CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
262 // ---------------------------------------------------------------------------
264 const CONSTRAINTS_FIELDS = {
266 NAME: { min: 1, max: 120 }, // Length
267 DESCRIPTION: { min: 3, max: 1000 }, // Length
268 USERNAME: { min: 1, max: 50 }, // Length
269 PASSWORD: { min: 6, max: 255 }, // Length
270 VIDEO_QUOTA: { min: -1 },
271 VIDEO_QUOTA_DAILY: { min: -1 },
272 VIDEO_LANGUAGES: { max: 500 }, // Array length
273 BLOCKED_REASON: { min: 3, max: 250 } // Length
276 REASON: { min: 2, max: 3000 }, // Length
277 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
280 MESSAGE: { min: 2, max: 3000 } // Length
283 REASON: { min: 2, max: 300 } // Length
286 NAME: { min: 1, max: 120 }, // Length
287 DESCRIPTION: { min: 3, max: 1000 }, // Length
288 SUPPORT: { min: 3, max: 1000 }, // Length
289 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
290 URL: { min: 3, max: 2000 } // Length
292 VIDEO_CHANNEL_SYNCS: {
293 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
297 EXTNAME: [ '.vtt', '.srt' ],
299 max: 20 * 1024 * 1024 // 20MB
304 URL: { min: 3, max: 2000 }, // Length
305 TORRENT_NAME: { min: 3, max: 255 }, // Length
307 EXTNAME: [ '.torrent' ],
309 max: 1024 * 200 // 200 KB
314 URL: { min: 3, max: 2000 } // Length
317 URL: { min: 3, max: 2000 } // Length
320 NAME: { min: 3, max: 120 }, // Length
321 LANGUAGE: { min: 1, max: 10 }, // Length
322 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
323 DESCRIPTION: { min: 3, max: 10000 }, // Length
324 SUPPORT: { min: 3, max: 1000 }, // Length
326 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
328 max: 4 * 1024 * 1024 // 4MB
331 EXTNAME: [] as string[],
332 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
333 DURATION: { min: 0 }, // Number
334 TAGS: { min: 0, max: 5 }, // Number of total tags
335 TAG: { min: 2, max: 30 }, // Length
338 DISLIKES: { min: 0 },
339 FILE_SIZE: { min: -1 },
340 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
341 URL: { min: 3, max: 2000 } // Length
344 NAME: { min: 1, max: 120 }, // Length
345 DESCRIPTION: { min: 3, max: 1000 }, // Length
346 URL: { min: 3, max: 2000 }, // Length
348 EXTNAME: [ '.jpg', '.jpeg' ],
350 max: 4 * 1024 * 1024 // 4MB
355 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
356 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
357 URL: { min: 3, max: 2000 }, // Length
359 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
361 max: 4 * 1024 * 1024 // 4MB
369 TEXT: { min: 1, max: 10000 }, // Length
370 URL: { min: 3, max: 2000 } // Length
373 URL: { min: 3, max: 2000 } // Length
376 FROM_NAME: { min: 1, max: 120 }, // Length
377 BODY: { min: 3, max: 5000 } // Length
380 NAME: { min: 1, max: 214 }, // Length
381 DESCRIPTION: { min: 1, max: 20000 } // Length
384 URL: { min: 5, max: 2000 } // Length
387 TASKS: { min: 1, max: 10 }, // Number of tasks
388 CUT_TIME: { min: 0 } // Value
391 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
392 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
393 CLIENT_META: { min: 1, max: 5000 }, // Length
394 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
398 const VIEW_LIFETIME = {
399 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
400 VIEWER_COUNTER: 60000 * 2, // 2 minutes
401 VIEWER_STATS: 60000 * 60 // 1 hour
404 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
406 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
408 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
410 STANDARD: [ 24, 25, 30 ],
411 HD_STANDARD: [ 50, 60 ],
415 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
418 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
420 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
425 const FFMPEG_NICE: { [ id: string ]: number } = {
426 // parent process defaults to niceness = 0
427 // reminder: lower = higher priority, max value is 19, lowest is -20
428 LIVE: 5, // prioritize over VOD and THUMBNAIL
433 const VIDEO_CATEGORIES = {
444 11: 'News & Politics',
448 15: 'Science & Technology',
454 // See https://creativecommons.org/licenses/?lang=en
455 const VIDEO_LICENCES = {
457 2: 'Attribution - Share Alike',
458 3: 'Attribution - No Derivatives',
459 4: 'Attribution - Non Commercial',
460 5: 'Attribution - Non Commercial - Share Alike',
461 6: 'Attribution - Non Commercial - No Derivatives',
462 7: 'Public Domain Dedication'
465 const VIDEO_LANGUAGES: { [id: string]: string } = {}
467 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
468 [VideoPrivacy.PUBLIC]: 'Public',
469 [VideoPrivacy.UNLISTED]: 'Unlisted',
470 [VideoPrivacy.PRIVATE]: 'Private',
471 [VideoPrivacy.INTERNAL]: 'Internal'
474 const VIDEO_STATES: { [ id in VideoState ]: string } = {
475 [VideoState.PUBLISHED]: 'Published',
476 [VideoState.TO_TRANSCODE]: 'To transcode',
477 [VideoState.TO_IMPORT]: 'To import',
478 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
479 [VideoState.LIVE_ENDED]: 'Livestream ended',
480 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
481 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
482 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
483 [VideoState.TO_EDIT]: 'To edit*'
486 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
487 [VideoImportState.FAILED]: 'Failed',
488 [VideoImportState.PENDING]: 'Pending',
489 [VideoImportState.SUCCESS]: 'Success',
490 [VideoImportState.REJECTED]: 'Rejected',
491 [VideoImportState.CANCELLED]: 'Cancelled',
492 [VideoImportState.PROCESSING]: 'Processing'
495 const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
496 [VideoChannelSyncState.FAILED]: 'Failed',
497 [VideoChannelSyncState.SYNCED]: 'Synchronized',
498 [VideoChannelSyncState.PROCESSING]: 'Processing',
499 [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
502 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
503 [AbuseState.PENDING]: 'Pending',
504 [AbuseState.REJECTED]: 'Rejected',
505 [AbuseState.ACCEPTED]: 'Accepted'
508 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
509 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
510 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
511 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
514 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
515 [VideoPlaylistType.REGULAR]: 'Regular',
516 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
522 'audio/mpeg': '.mp3',
525 'application/ogg': '.ogg',
528 'audio/x-ms-wma': '.wma',
530 'audio/x-wav': '.wav',
532 'audio/x-flac': '.flac',
533 'audio/flac': '.flac',
535 'audio/vnd.dlna.adts': '.aac',
540 'audio/x-m4a': '.m4a',
542 'audio/vnd.dolby.dd-raw': '.ac3',
545 EXT_MIMETYPE: null as { [ id: string ]: string }
548 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
549 MIMETYPES_REGEX: null as string,
550 EXT_MIMETYPE: null as { [ id: string ]: string }
556 'image/webp': '.webp',
560 EXT_MIMETYPE: null as { [ id: string ]: string }
565 'application/x-subrip': '.srt',
571 'application/x-bittorrent': '.torrent'
575 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
576 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
578 const BINARY_CONTENT_TYPES = new Set([
579 'binary/octet-stream',
580 'application/octet-stream',
581 'application/x-binary'
584 // ---------------------------------------------------------------------------
593 // ---------------------------------------------------------------------------
595 const SERVER_ACTOR_NAME = 'peertube'
597 const ACTIVITY_PUB = {
598 POTENTIAL_ACCEPT_HEADERS: [
599 'application/activity+json',
600 'application/ld+json',
601 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
603 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
604 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
605 COLLECTION_ITEMS_PER_PAGE: 10,
606 FETCH_PAGE_LIMIT: 2000,
608 VIDEO: [] as string[],
609 TORRENT: [ 'application/x-bittorrent' ],
610 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
612 MAX_RECURSION_COMMENTS: 100,
613 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
614 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
615 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
618 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
621 APPLICATION: 'Application',
622 ORGANIZATION: 'Organization',
626 const HTTP_SIGNATURE = {
627 HEADER_NAME: 'signature',
628 ALGORITHM: 'rsa-sha256',
629 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
630 CLOCK_SKEW_SECONDS: 1800
633 // ---------------------------------------------------------------------------
635 let PRIVATE_RSA_KEY_SIZE = 2048
637 // Password encryption
638 const BCRYPT_SALT_SIZE = 10
640 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
641 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
643 const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
645 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
647 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
648 DO_NOT_LIST: 'do_not_list',
653 // ---------------------------------------------------------------------------
655 // Express static paths (router)
656 const STATIC_PATHS = {
657 THUMBNAILS: '/static/thumbnails/',
658 WEBSEED: '/static/webseed/',
659 REDUNDANCY: '/static/redundancy/',
660 STREAMING_PLAYLISTS: {
661 HLS: '/static/streaming-playlists/hls'
664 const STATIC_DOWNLOAD_PATHS = {
665 TORRENTS: '/download/torrents/',
666 VIDEOS: '/download/videos/',
667 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
669 const LAZY_STATIC_PATHS = {
670 BANNERS: '/lazy-static/banners/',
671 AVATARS: '/lazy-static/avatars/',
672 PREVIEWS: '/lazy-static/previews/',
673 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
674 TORRENTS: '/lazy-static/torrents/'
678 const STATIC_MAX_AGE = {
684 // Videos thumbnail size
685 const THUMBNAILS_SIZE = {
690 const PREVIEWS_SIZE = {
695 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[]} = {
696 [ActorImageType.AVATAR]: [
706 [ActorImageType.BANNER]: [
709 height: 317 // 6/1 ratio
719 // Sub folders of cache directory
720 const FILES_CACHE = {
722 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
723 MAX_AGE: 1000 * 3600 * 3 // 3 hours
726 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
727 MAX_AGE: 1000 * 3600 * 3 // 3 hours
730 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
731 MAX_AGE: 1000 * 3600 * 3 // 3 hours
739 ACTOR_IMAGE_STATIC: {
744 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
745 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
746 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
748 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
752 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
753 SEGMENT_TIME_SECONDS: {
754 DEFAULT_LATENCY: 4, // 4 seconds
755 SMALL_LATENCY: 2 // 2 seconds
757 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
758 REPLAY_DIRECTORY: 'replay',
759 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
760 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
770 const MEMOIZE_TTL = {
771 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
772 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
773 VIDEO_DURATION: 1000 * 10, // 10 seconds
774 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
775 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
776 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
779 const MEMOIZE_LENGTH = {
780 INFO_HASH_EXISTS: 200,
784 const WORKER_THREADS = {
793 SEQUENTIAL_HTTP_BROADCAST: {
797 PARALLEL_HTTP_BROADCAST: {
798 CONCURRENCY: JOB_CONCURRENCY['activitypub-http-broadcast-parallel'],
809 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
811 HEADER_NAME: 'x-peertube-otp',
812 HEADER_REQUIRED_VALUE: 'required; app'
815 const ASSETS_PATH = {
816 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
817 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
820 // ---------------------------------------------------------------------------
822 const CUSTOM_HTML_TAG_COMMENTS = {
823 TITLE: '<!-- title tag -->',
824 DESCRIPTION: '<!-- description tag -->',
825 CUSTOM_CSS: '<!-- custom css tag -->',
826 META_TAGS: '<!-- meta tags -->',
827 SERVER_CONFIG: '<!-- server config -->'
830 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
831 const LOG_FILENAME = 'peertube.log'
832 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
834 // ---------------------------------------------------------------------------
836 const TRACKER_RATE_LIMITS = {
837 INTERVAL: 60000 * 5, // 5 minutes
838 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
839 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
840 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
843 const P2P_MEDIA_LOADER_PEER_VERSION = 2
845 // ---------------------------------------------------------------------------
847 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
848 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
850 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
852 const DEFAULT_THEME_NAME = 'default'
853 const DEFAULT_USER_THEME_NAME = 'instance-default'
855 // ---------------------------------------------------------------------------
857 const SEARCH_INDEX = {
859 VIDEOS: '/api/v1/search/videos',
860 VIDEO_CHANNELS: '/api/v1/search/video-channels'
864 // ---------------------------------------------------------------------------
866 const STATS_TIMESERIE = {
867 MAX_DAYS: 365 * 10 // Around 10 years
870 // ---------------------------------------------------------------------------
872 // Special constants for a test instance
873 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
874 if (isTestOrDevInstance()) {
875 PRIVATE_RSA_KEY_SIZE = 1024
877 ACTOR_FOLLOW_SCORE.BASE = 20
879 REMOTE_SCHEME.HTTP = 'http'
880 REMOTE_SCHEME.WS = 'ws'
882 STATIC_MAX_AGE.SERVER = '0'
884 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
885 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
886 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
887 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
888 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
889 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
890 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
891 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
893 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
895 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
896 AP_CLEANER.PERIOD = 5000
898 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
900 CONTACT_FORM_LIFETIME = 1000 // 1 second
902 JOB_ATTEMPTS['email'] = 1
904 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
905 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
906 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
907 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
909 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
912 if (isTestInstance()) {
913 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
914 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
915 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
916 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
918 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
919 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
921 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
922 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
924 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
925 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
926 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
927 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
931 updateWebserverUrls()
932 updateWebserverConfig()
934 registerConfigChangedHandler(() => {
935 updateWebserverUrls()
936 updateWebserverConfig()
939 // ---------------------------------------------------------------------------
941 const FILES_CONTENT_HASH = {
942 MANIFEST: generateContentHash(),
943 FAVICON: generateContentHash(),
944 LOGO: generateContentHash()
947 // ---------------------------------------------------------------------------
949 const VIDEO_FILTERS = {
952 HORIZONTAL_MARGIN_RATIO: 1 / 20,
953 VERTICAL_MARGIN_RATIO: 1 / 20
957 // ---------------------------------------------------------------------------
966 RESUMABLE_UPLOAD_DIRECTORY,
967 RESUMABLE_UPLOAD_SESSION_LIFETIME,
968 HLS_REDUNDANCY_DIRECTORY,
969 P2P_MEDIA_LOADER_PEER_VERSION,
982 LAST_MIGRATION_VERSION,
984 CUSTOM_HTML_TAG_COMMENTS,
986 BROADCAST_CONCURRENCY,
993 DEFAULT_USER_THEME_NAME,
995 TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
996 PLUGIN_GLOBAL_CSS_FILE_NAME,
997 PLUGIN_GLOBAL_CSS_PATH,
998 PRIVATE_RSA_KEY_SIZE,
1000 ROUTE_CACHE_LIFETIME,
1002 HLS_STREAMING_PLAYLIST_DIRECTORY,
1008 VIDEO_IMPORT_TIMEOUT,
1009 VIDEO_PLAYLIST_TYPES,
1010 MAX_LOGS_OUTPUT_CHARACTERS,
1012 ACTIVITY_PUB_ACTOR_TYPES,
1023 VIDEO_TRANSCODING_FPS,
1028 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
1029 USER_PASSWORD_RESET_LIFETIME,
1030 USER_PASSWORD_CREATE_LIFETIME,
1032 USER_EMAIL_VERIFY_LIFETIME,
1034 SCHEDULER_INTERVALS_MS,
1036 STATIC_DOWNLOAD_PATHS,
1038 CRAWL_REQUEST_CONCURRENCY,
1039 DEFAULT_AUDIO_RESOLUTION,
1040 BINARY_CONTENT_TYPES,
1041 JOB_COMPLETED_LIFETIME,
1043 VIDEO_IMPORT_STATES,
1044 VIDEO_CHANNEL_SYNC_STATE,
1046 CONTACT_FORM_LIFETIME,
1047 VIDEO_PLAYLIST_PRIVACIES,
1048 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1057 // ---------------------------------------------------------------------------
1059 function buildVideoMimetypeExt () {
1061 // streamable formats that warrant cross-browser compatibility
1062 'video/webm': '.webm',
1063 // We'll add .ogg if additional extensions are enabled
1064 // We could add .ogg here but since it could be an audio file,
1065 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1066 'video/ogg': [ '.ogv' ],
1070 if (CONFIG.TRANSCODING.ENABLED) {
1071 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1072 data['video/ogg'].push('.ogg')
1074 Object.assign(data, {
1075 'video/x-matroska': '.mkv',
1077 // Developed by Apple
1078 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1079 'video/x-m4v': '.m4v',
1080 'video/m4v': '.m4v',
1082 // Developed by the Adobe Flash Platform
1083 'video/x-flv': '.flv',
1084 'video/x-f4v': '.f4v', // replacement for flv
1086 // Developed by Microsoft
1087 'video/x-ms-wmv': '.wmv',
1088 'video/x-msvideo': '.avi',
1089 'video/avi': '.avi',
1091 // Developed by 3GPP
1092 // common video formats for cell phones
1093 'video/3gpp': [ '.3gp', '.3gpp' ],
1094 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1096 // Developed by FFmpeg/Mplayer
1097 'application/x-nut': '.nut',
1099 // The standard video format used by many Sony and Panasonic HD camcorders.
1100 // It is also used for storing high definition video on Blu-ray discs.
1101 'video/mp2t': '.mts',
1102 'video/vnd.dlna.mpeg-tts': '.mts',
1104 'video/m2ts': '.m2ts',
1106 // Old formats reliant on MPEG-1/MPEG-2
1107 'video/mpv': '.mpv',
1108 'video/mpeg2': '.m2v',
1109 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1110 'video/dvd': '.vob',
1112 // Could be anything
1113 'application/octet-stream': null,
1114 'application/mxf': '.mxf' // often used as exchange format by editing software
1118 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1119 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1126 function updateWebserverUrls () {
1127 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1128 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1129 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1131 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1132 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1133 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1135 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1136 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1138 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1139 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1142 function updateWebserverConfig () {
1143 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1144 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1146 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1148 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1150 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1153 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1154 const result: { [id: string]: string } = {}
1156 for (const mimetype of Object.keys(obj)) {
1157 const value = obj[mimetype]
1158 if (!value) continue
1160 const extensions = Array.isArray(value) ? value : [ value ]
1162 for (const extension of extensions) {
1163 result[extension] = mimetype
1170 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1171 return Object.keys(obj)
1176 function loadLanguages () {
1177 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1180 function buildLanguages () {
1181 const iso639 = require('iso-639-3')
1183 const languages: { [id: string]: string } = {}
1185 const additionalLanguages = {
1186 sgn: true, // Sign languages (macro language)
1187 ase: true, // American sign language
1188 sdl: true, // Arabian sign language
1189 bfi: true, // British sign language
1190 bzs: true, // Brazilian sign language
1191 csl: true, // Chinese sign language
1192 cse: true, // Czech sign language
1193 dsl: true, // Danish sign language
1194 fsl: true, // French sign language
1195 gsg: true, // German sign language
1196 pks: true, // Pakistan sign language
1197 jsl: true, // Japanese sign language
1198 sfs: true, // South African sign language
1199 swl: true, // Swedish sign language
1200 rsl: true, // Russian sign language
1202 kab: true, // Kabyle
1206 epo: true, // Esperanto
1207 tlh: true, // Klingon
1208 jbo: true, // Lojban
1209 avk: true, // Kotava
1211 zxx: true // No linguistic content (ISO-639-2)
1214 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1217 return (l.iso6391 !== undefined && l.type === 'living') ||
1218 additionalLanguages[l.iso6393] === true
1220 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1222 // Override Occitan label
1223 languages['oc'] = 'Occitan'
1224 languages['el'] = 'Greek'
1225 languages['tok'] = 'Toki Pona'
1227 // Chinese languages
1228 languages['zh-Hans'] = 'Simplified Chinese'
1229 languages['zh-Hant'] = 'Traditional Chinese'
1234 function generateContentHash () {
1235 return randomBytes(20).toString('hex')
1238 function getIntEnv (path: string) {
1239 if (process.env[path]) return parseInt(process.env[path])