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'
15 } from '../../shared/models'
16 import { ActivityPubActorType } from '../../shared/models/activitypub'
17 import { ActorImageType, FollowState } from '../../shared/models/actors'
18 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
19 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
20 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
21 // Do not use barrels, remain constants as independent as possible
22 import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
23 import { CONFIG, registerConfigChangedHandler } from './config'
25 // ---------------------------------------------------------------------------
27 const LAST_MIGRATION_VERSION = 725
29 // ---------------------------------------------------------------------------
31 const API_VERSION = 'v1'
32 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
59 // Sortable columns per schema
60 const SORTABLE_COLUMNS = {
61 ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
62 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
63 ACCOUNTS: [ 'createdAt' ],
64 JOBS: [ 'createdAt' ],
65 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
66 VIDEO_IMPORTS: [ 'createdAt' ],
68 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
69 VIDEO_COMMENTS: [ 'createdAt' ],
71 VIDEO_RATES: [ 'createdAt' ],
72 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
74 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
75 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
76 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
77 CHANNEL_FOLLOWERS: [ 'createdAt' ],
79 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
81 // Don't forget to update peertube-search-index with the same values
82 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
83 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
84 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
86 ABUSES: [ 'id', 'createdAt', 'state' ],
88 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
89 SERVERS_BLOCKLIST: [ 'createdAt' ],
91 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
93 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
95 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
97 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
99 VIDEO_REDUNDANCIES: [ 'name' ]
102 const OAUTH_LIFETIME = {
103 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
104 REFRESH_TOKEN: 1209600 // 2 weeks
107 const ROUTE_CACHE_LIFETIME = {
111 SECURITYTXT: '2 hours',
112 NODEINFO: '10 minutes',
113 DNT_POLICY: '1 week',
115 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
120 // ---------------------------------------------------------------------------
122 // Number of points we add/remove after a successful/bad request
123 const ACTOR_FOLLOW_SCORE = {
130 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
132 ACCEPTED: 'accepted',
136 const REMOTE_SCHEME = {
141 const JOB_ATTEMPTS: { [id in JobType]: number } = {
142 'activitypub-http-broadcast': 1,
143 'activitypub-http-broadcast-parallel': 1,
144 'activitypub-http-unicast': 1,
145 'activitypub-http-fetcher': 2,
146 'activitypub-follow': 5,
147 'activitypub-cleaner': 1,
148 'video-file-import': 1,
149 'video-transcoding': 1,
153 'videos-views-stats': 1,
154 'activitypub-refresher': 1,
155 'video-redundancy': 1,
156 'video-live-ending': 1,
157 'video-studio-edition': 1,
158 'manage-video-torrent': 1,
159 'move-to-object-storage': 3,
163 // Excluded keys are jobs that can be configured by admins
164 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
165 'activitypub-http-broadcast': 1,
166 'activitypub-http-broadcast-parallel': 30,
167 'activitypub-http-unicast': 10,
168 'activitypub-http-fetcher': 3,
169 'activitypub-cleaner': 1,
170 'activitypub-follow': 1,
171 'video-file-import': 1,
174 'videos-views-stats': 1,
175 'activitypub-refresher': 1,
176 'video-redundancy': 1,
177 'video-live-ending': 10,
178 'video-studio-edition': 1,
179 'manage-video-torrent': 1,
180 'move-to-object-storage': 1,
184 const JOB_TTL: { [id in JobType]: number } = {
185 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
186 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
187 'activitypub-http-unicast': 60000 * 10, // 10 minutes
188 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
189 'activitypub-follow': 60000 * 10, // 10 minutes
190 'activitypub-cleaner': 1000 * 3600, // 1 hour
191 'video-file-import': 1000 * 3600, // 1 hour
192 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
193 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
194 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
195 'email': 60000 * 10, // 10 minutes
196 'actor-keys': 60000 * 20, // 20 minutes
197 'videos-views-stats': undefined, // Unlimited
198 'activitypub-refresher': 60000 * 10, // 10 minutes
199 'video-redundancy': 1000 * 3600 * 3, // 3 hours
200 'video-live-ending': 1000 * 60 * 10, // 10 minutes
201 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
202 'notify': 60000 * 5, // 5 minutes
203 'federate-video': 60000 * 5, // 5 minutes
204 'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours
206 const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
207 'videos-views-stats': {
208 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
210 'activitypub-cleaner': {
211 cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
214 const JOB_PRIORITY = {
218 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
219 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
222 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
223 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
224 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
227 const REQUEST_TIMEOUTS = {
228 DEFAULT: 7000, // 7 seconds
229 FILE: 30000, // 30 seconds
230 REDUNDANCY: JOB_TTL['video-redundancy']
233 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
234 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
236 const SCHEDULER_INTERVALS_MS = {
237 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
238 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
239 UPDATE_VIDEOS: 60000, // 1 minute
240 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
241 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
242 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
243 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
244 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
245 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
246 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
247 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
248 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
249 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 // 1 hour
252 // ---------------------------------------------------------------------------
254 const CONSTRAINTS_FIELDS = {
256 NAME: { min: 1, max: 120 }, // Length
257 DESCRIPTION: { min: 3, max: 1000 }, // Length
258 USERNAME: { min: 1, max: 50 }, // Length
259 PASSWORD: { min: 6, max: 255 }, // Length
260 VIDEO_QUOTA: { min: -1 },
261 VIDEO_QUOTA_DAILY: { min: -1 },
262 VIDEO_LANGUAGES: { max: 500 }, // Array length
263 BLOCKED_REASON: { min: 3, max: 250 } // Length
266 REASON: { min: 2, max: 3000 }, // Length
267 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
270 MESSAGE: { min: 2, max: 3000 } // Length
273 REASON: { min: 2, max: 300 } // Length
276 NAME: { min: 1, max: 120 }, // Length
277 DESCRIPTION: { min: 3, max: 1000 }, // Length
278 SUPPORT: { min: 3, max: 1000 }, // Length
279 URL: { min: 3, max: 2000 } // Length
283 EXTNAME: [ '.vtt', '.srt' ],
285 max: 20 * 1024 * 1024 // 20MB
290 URL: { min: 3, max: 2000 }, // Length
291 TORRENT_NAME: { min: 3, max: 255 }, // Length
293 EXTNAME: [ '.torrent' ],
295 max: 1024 * 200 // 200 KB
300 URL: { min: 3, max: 2000 } // Length
303 URL: { min: 3, max: 2000 } // Length
306 NAME: { min: 3, max: 120 }, // Length
307 LANGUAGE: { min: 1, max: 10 }, // Length
308 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
309 DESCRIPTION: { min: 3, max: 10000 }, // Length
310 SUPPORT: { min: 3, max: 1000 }, // Length
312 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
314 max: 4 * 1024 * 1024 // 4MB
317 EXTNAME: [] as string[],
318 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
319 DURATION: { min: 0 }, // Number
320 TAGS: { min: 0, max: 5 }, // Number of total tags
321 TAG: { min: 2, max: 30 }, // Length
324 DISLIKES: { min: 0 },
325 FILE_SIZE: { min: -1 },
326 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
327 URL: { min: 3, max: 2000 } // Length
330 NAME: { min: 1, max: 120 }, // Length
331 DESCRIPTION: { min: 3, max: 1000 }, // Length
332 URL: { min: 3, max: 2000 }, // Length
334 EXTNAME: [ '.jpg', '.jpeg' ],
336 max: 4 * 1024 * 1024 // 4MB
341 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
342 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
343 URL: { min: 3, max: 2000 }, // Length
345 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
347 max: 4 * 1024 * 1024 // 4MB
355 TEXT: { min: 1, max: 10000 }, // Length
356 URL: { min: 3, max: 2000 } // Length
359 URL: { min: 3, max: 2000 } // Length
362 FROM_NAME: { min: 1, max: 120 }, // Length
363 BODY: { min: 3, max: 5000 } // Length
366 NAME: { min: 1, max: 214 }, // Length
367 DESCRIPTION: { min: 1, max: 20000 } // Length
370 URL: { min: 5, max: 2000 } // Length
373 TASKS: { min: 1, max: 10 }, // Number of tasks
374 CUT_TIME: { min: 0 } // Value
377 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
378 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
379 CLIENT_META: { min: 1, max: 5000 }, // Length
380 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
384 const VIEW_LIFETIME = {
385 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
386 VIEWER_COUNTER: 60000 * 2, // 2 minutes
387 VIEWER_STATS: 60000 * 60 // 1 hour
390 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
392 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
394 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
396 STANDARD: [ 24, 25, 30 ],
397 HD_STANDARD: [ 50, 60 ],
401 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
404 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
406 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
411 const FFMPEG_NICE: { [ id: string ]: number } = {
412 // parent process defaults to niceness = 0
413 // reminder: lower = higher priority, max value is 19, lowest is -20
414 LIVE: 5, // prioritize over VOD and THUMBNAIL
419 const VIDEO_CATEGORIES = {
430 11: 'News & Politics',
434 15: 'Science & Technology',
440 // See https://creativecommons.org/licenses/?lang=en
441 const VIDEO_LICENCES = {
443 2: 'Attribution - Share Alike',
444 3: 'Attribution - No Derivatives',
445 4: 'Attribution - Non Commercial',
446 5: 'Attribution - Non Commercial - Share Alike',
447 6: 'Attribution - Non Commercial - No Derivatives',
448 7: 'Public Domain Dedication'
451 const VIDEO_LANGUAGES: { [id: string]: string } = {}
453 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
454 [VideoPrivacy.PUBLIC]: 'Public',
455 [VideoPrivacy.UNLISTED]: 'Unlisted',
456 [VideoPrivacy.PRIVATE]: 'Private',
457 [VideoPrivacy.INTERNAL]: 'Internal'
460 const VIDEO_STATES: { [ id in VideoState ]: string } = {
461 [VideoState.PUBLISHED]: 'Published',
462 [VideoState.TO_TRANSCODE]: 'To transcode',
463 [VideoState.TO_IMPORT]: 'To import',
464 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
465 [VideoState.LIVE_ENDED]: 'Livestream ended',
466 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
467 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
468 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
469 [VideoState.TO_EDIT]: 'To edit*'
472 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
473 [VideoImportState.FAILED]: 'Failed',
474 [VideoImportState.PENDING]: 'Pending',
475 [VideoImportState.SUCCESS]: 'Success',
476 [VideoImportState.REJECTED]: 'Rejected',
477 [VideoImportState.CANCELLED]: 'Cancelled',
478 [VideoImportState.PROCESSING]: 'Processing'
481 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
482 [AbuseState.PENDING]: 'Pending',
483 [AbuseState.REJECTED]: 'Rejected',
484 [AbuseState.ACCEPTED]: 'Accepted'
487 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
488 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
489 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
490 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
493 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
494 [VideoPlaylistType.REGULAR]: 'Regular',
495 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
501 'audio/mpeg': '.mp3',
504 'application/ogg': '.ogg',
507 'audio/x-ms-wma': '.wma',
509 'audio/x-wav': '.wav',
511 'audio/x-flac': '.flac',
512 'audio/flac': '.flac',
514 'audio/vnd.dlna.adts': '.aac',
519 'audio/x-m4a': '.m4a',
521 'audio/vnd.dolby.dd-raw': '.ac3',
524 EXT_MIMETYPE: null as { [ id: string ]: string }
527 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
528 MIMETYPES_REGEX: null as string,
529 EXT_MIMETYPE: null as { [ id: string ]: string }
535 'image/webp': '.webp',
539 EXT_MIMETYPE: null as { [ id: string ]: string }
544 'application/x-subrip': '.srt',
550 'application/x-bittorrent': '.torrent'
554 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
555 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
557 const BINARY_CONTENT_TYPES = new Set([
558 'binary/octet-stream',
559 'application/octet-stream',
560 'application/x-binary'
563 // ---------------------------------------------------------------------------
572 // ---------------------------------------------------------------------------
574 const SERVER_ACTOR_NAME = 'peertube'
576 const ACTIVITY_PUB = {
577 POTENTIAL_ACCEPT_HEADERS: [
578 'application/activity+json',
579 'application/ld+json',
580 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
582 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
583 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
584 COLLECTION_ITEMS_PER_PAGE: 10,
585 FETCH_PAGE_LIMIT: 2000,
587 VIDEO: [] as string[],
588 TORRENT: [ 'application/x-bittorrent' ],
589 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
591 MAX_RECURSION_COMMENTS: 100,
592 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
593 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
594 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
597 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
600 APPLICATION: 'Application',
601 ORGANIZATION: 'Organization',
605 const HTTP_SIGNATURE = {
606 HEADER_NAME: 'signature',
607 ALGORITHM: 'rsa-sha256',
608 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
609 CLOCK_SKEW_SECONDS: 1800
612 // ---------------------------------------------------------------------------
614 let PRIVATE_RSA_KEY_SIZE = 2048
616 // Password encryption
617 const BCRYPT_SALT_SIZE = 10
619 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
620 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
622 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
624 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
625 DO_NOT_LIST: 'do_not_list',
630 // ---------------------------------------------------------------------------
632 // Express static paths (router)
633 const STATIC_PATHS = {
634 THUMBNAILS: '/static/thumbnails/',
635 WEBSEED: '/static/webseed/',
636 REDUNDANCY: '/static/redundancy/',
637 STREAMING_PLAYLISTS: {
638 HLS: '/static/streaming-playlists/hls'
641 const STATIC_DOWNLOAD_PATHS = {
642 TORRENTS: '/download/torrents/',
643 VIDEOS: '/download/videos/',
644 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
646 const LAZY_STATIC_PATHS = {
647 BANNERS: '/lazy-static/banners/',
648 AVATARS: '/lazy-static/avatars/',
649 PREVIEWS: '/lazy-static/previews/',
650 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
651 TORRENTS: '/lazy-static/torrents/'
655 const STATIC_MAX_AGE = {
661 // Videos thumbnail size
662 const THUMBNAILS_SIZE = {
667 const PREVIEWS_SIZE = {
672 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[]} = {
673 [ActorImageType.AVATAR]: [
683 [ActorImageType.BANNER]: [
686 height: 317 // 6/1 ratio
696 // Sub folders of cache directory
697 const FILES_CACHE = {
699 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
700 MAX_AGE: 1000 * 3600 * 3 // 3 hours
703 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
704 MAX_AGE: 1000 * 3600 * 3 // 3 hours
707 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
708 MAX_AGE: 1000 * 3600 * 3 // 3 hours
716 ACTOR_IMAGE_STATIC: {
721 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
722 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
723 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
725 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
729 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
730 SEGMENT_TIME_SECONDS: {
731 DEFAULT_LATENCY: 4, // 4 seconds
732 SMALL_LATENCY: 2 // 2 seconds
734 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
735 REPLAY_DIRECTORY: 'replay',
736 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
737 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
747 const MEMOIZE_TTL = {
748 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
749 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
750 VIDEO_DURATION: 1000 * 10, // 10 seconds
751 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
752 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
753 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
756 const MEMOIZE_LENGTH = {
757 INFO_HASH_EXISTS: 200,
761 const WORKER_THREADS = {
778 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
780 const ASSETS_PATH = {
781 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
782 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
785 // ---------------------------------------------------------------------------
787 const CUSTOM_HTML_TAG_COMMENTS = {
788 TITLE: '<!-- title tag -->',
789 DESCRIPTION: '<!-- description tag -->',
790 CUSTOM_CSS: '<!-- custom css tag -->',
791 META_TAGS: '<!-- meta tags -->',
792 SERVER_CONFIG: '<!-- server config -->'
795 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
796 const LOG_FILENAME = 'peertube.log'
797 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
799 // ---------------------------------------------------------------------------
801 const TRACKER_RATE_LIMITS = {
802 INTERVAL: 60000 * 5, // 5 minutes
803 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
804 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
805 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
808 const P2P_MEDIA_LOADER_PEER_VERSION = 2
810 // ---------------------------------------------------------------------------
812 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
813 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
815 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
817 const DEFAULT_THEME_NAME = 'default'
818 const DEFAULT_USER_THEME_NAME = 'instance-default'
820 // ---------------------------------------------------------------------------
822 const SEARCH_INDEX = {
824 VIDEOS: '/api/v1/search/videos',
825 VIDEO_CHANNELS: '/api/v1/search/video-channels'
829 // ---------------------------------------------------------------------------
831 const STATS_TIMESERIE = {
832 MAX_DAYS: 365 * 10 // Around 10 years
835 // ---------------------------------------------------------------------------
837 // Special constants for a test instance
838 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
839 if (isTestOrDevInstance()) {
840 PRIVATE_RSA_KEY_SIZE = 1024
842 ACTOR_FOLLOW_SCORE.BASE = 20
844 REMOTE_SCHEME.HTTP = 'http'
845 REMOTE_SCHEME.WS = 'ws'
847 STATIC_MAX_AGE.SERVER = '0'
849 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
850 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
851 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
852 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
853 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
854 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
855 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
856 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
858 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
860 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
861 AP_CLEANER.PERIOD = 5000
863 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
865 CONTACT_FORM_LIFETIME = 1000 // 1 second
867 JOB_ATTEMPTS['email'] = 1
869 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
870 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
871 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
872 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
874 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
877 if (isTestInstance()) {
878 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
879 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
880 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
881 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
883 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
884 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
886 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
887 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
889 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
890 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
891 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
892 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
896 updateWebserverUrls()
897 updateWebserverConfig()
899 registerConfigChangedHandler(() => {
900 updateWebserverUrls()
901 updateWebserverConfig()
904 // ---------------------------------------------------------------------------
906 const FILES_CONTENT_HASH = {
907 MANIFEST: generateContentHash(),
908 FAVICON: generateContentHash(),
909 LOGO: generateContentHash()
912 // ---------------------------------------------------------------------------
914 const VIDEO_FILTERS = {
917 HORIZONTAL_MARGIN_RATIO: 1 / 20,
918 VERTICAL_MARGIN_RATIO: 1 / 20
922 // ---------------------------------------------------------------------------
931 RESUMABLE_UPLOAD_DIRECTORY,
932 RESUMABLE_UPLOAD_SESSION_LIFETIME,
933 HLS_REDUNDANCY_DIRECTORY,
934 P2P_MEDIA_LOADER_PEER_VERSION,
947 LAST_MIGRATION_VERSION,
949 CUSTOM_HTML_TAG_COMMENTS,
951 BROADCAST_CONCURRENCY,
958 DEFAULT_USER_THEME_NAME,
960 PLUGIN_GLOBAL_CSS_FILE_NAME,
961 PLUGIN_GLOBAL_CSS_PATH,
962 PRIVATE_RSA_KEY_SIZE,
964 ROUTE_CACHE_LIFETIME,
966 HLS_STREAMING_PLAYLIST_DIRECTORY,
972 VIDEO_IMPORT_TIMEOUT,
973 VIDEO_PLAYLIST_TYPES,
974 MAX_LOGS_OUTPUT_CHARACTERS,
976 ACTIVITY_PUB_ACTOR_TYPES,
987 VIDEO_TRANSCODING_FPS,
992 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
993 USER_PASSWORD_RESET_LIFETIME,
994 USER_PASSWORD_CREATE_LIFETIME,
996 USER_EMAIL_VERIFY_LIFETIME,
998 SCHEDULER_INTERVALS_MS,
1000 STATIC_DOWNLOAD_PATHS,
1002 CRAWL_REQUEST_CONCURRENCY,
1003 DEFAULT_AUDIO_RESOLUTION,
1004 BINARY_CONTENT_TYPES,
1005 JOB_COMPLETED_LIFETIME,
1007 VIDEO_IMPORT_STATES,
1009 CONTACT_FORM_LIFETIME,
1010 VIDEO_PLAYLIST_PRIVACIES,
1011 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1019 // ---------------------------------------------------------------------------
1021 function buildVideoMimetypeExt () {
1023 // streamable formats that warrant cross-browser compatibility
1024 'video/webm': '.webm',
1025 // We'll add .ogg if additional extensions are enabled
1026 // We could add .ogg here but since it could be an audio file,
1027 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1028 'video/ogg': [ '.ogv' ],
1032 if (CONFIG.TRANSCODING.ENABLED) {
1033 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1034 data['video/ogg'].push('.ogg')
1036 Object.assign(data, {
1037 'video/x-matroska': '.mkv',
1039 // Developed by Apple
1040 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1041 'video/x-m4v': '.m4v',
1042 'video/m4v': '.m4v',
1044 // Developed by the Adobe Flash Platform
1045 'video/x-flv': '.flv',
1046 'video/x-f4v': '.f4v', // replacement for flv
1048 // Developed by Microsoft
1049 'video/x-ms-wmv': '.wmv',
1050 'video/x-msvideo': '.avi',
1051 'video/avi': '.avi',
1053 // Developed by 3GPP
1054 // common video formats for cell phones
1055 'video/3gpp': [ '.3gp', '.3gpp' ],
1056 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1058 // Developed by FFmpeg/Mplayer
1059 'application/x-nut': '.nut',
1061 // The standard video format used by many Sony and Panasonic HD camcorders.
1062 // It is also used for storing high definition video on Blu-ray discs.
1063 'video/mp2t': '.mts',
1064 'video/vnd.dlna.mpeg-tts': '.mts',
1066 'video/m2ts': '.m2ts',
1068 // Old formats reliant on MPEG-1/MPEG-2
1069 'video/mpv': '.mpv',
1070 'video/mpeg2': '.m2v',
1071 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1072 'video/dvd': '.vob',
1074 // Could be anything
1075 'application/octet-stream': null,
1076 'application/mxf': '.mxf' // often used as exchange format by editing software
1080 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1081 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1088 function updateWebserverUrls () {
1089 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1090 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1091 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1093 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1094 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1095 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1097 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1098 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1100 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1101 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1104 function updateWebserverConfig () {
1105 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1106 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1108 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1110 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1112 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1115 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1116 const result: { [id: string]: string } = {}
1118 for (const mimetype of Object.keys(obj)) {
1119 const value = obj[mimetype]
1120 if (!value) continue
1122 const extensions = Array.isArray(value) ? value : [ value ]
1124 for (const extension of extensions) {
1125 result[extension] = mimetype
1132 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1133 return Object.keys(obj)
1138 function loadLanguages () {
1139 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1142 function buildLanguages () {
1143 const iso639 = require('iso-639-3')
1145 const languages: { [id: string]: string } = {}
1147 const additionalLanguages = {
1148 sgn: true, // Sign languages (macro language)
1149 ase: true, // American sign language
1150 sdl: true, // Arabian sign language
1151 bfi: true, // British sign language
1152 bzs: true, // Brazilian sign language
1153 csl: true, // Chinese sign language
1154 cse: true, // Czech sign language
1155 dsl: true, // Danish sign language
1156 fsl: true, // French sign language
1157 gsg: true, // German sign language
1158 pks: true, // Pakistan sign language
1159 jsl: true, // Japanese sign language
1160 sfs: true, // South African sign language
1161 swl: true, // Swedish sign language
1162 rsl: true, // Russian sign language
1164 kab: true, // Kabyle
1168 epo: true, // Esperanto
1169 tlh: true, // Klingon
1170 jbo: true, // Lojban
1171 avk: true, // Kotava
1173 zxx: true // No linguistic content (ISO-639-2)
1176 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1179 return (l.iso6391 !== undefined && l.type === 'living') ||
1180 additionalLanguages[l.iso6393] === true
1182 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1184 // Override Occitan label
1185 languages['oc'] = 'Occitan'
1186 languages['el'] = 'Greek'
1187 languages['tok'] = 'Toki Pona'
1189 // Chinese languages
1190 languages['zh-Hans'] = 'Simplified Chinese'
1191 languages['zh-Hant'] = 'Traditional Chinese'
1196 function generateContentHash () {
1197 return randomBytes(20).toString('hex')
1200 function getIntEnv (path: string) {
1201 if (process.env[path]) return parseInt(process.env[path])