1 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
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 = 720
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 } = {
135 const REMOTE_SCHEME = {
140 const JOB_ATTEMPTS: { [id in JobType]: number } = {
141 'activitypub-http-broadcast': 1,
142 'activitypub-http-broadcast-parallel': 1,
143 'activitypub-http-unicast': 1,
144 'activitypub-http-fetcher': 2,
145 'activitypub-follow': 5,
146 'activitypub-cleaner': 1,
147 'video-file-import': 1,
148 'video-transcoding': 1,
152 'videos-views-stats': 1,
153 'activitypub-refresher': 1,
154 'video-redundancy': 1,
155 'video-live-ending': 1,
156 'video-studio-edition': 1,
157 'manage-video-torrent': 1,
158 'move-to-object-storage': 3
160 // Excluded keys are jobs that can be configured by admins
161 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
162 'activitypub-http-broadcast': 1,
163 'activitypub-http-broadcast-parallel': 30,
164 'activitypub-http-unicast': 10,
165 'activitypub-http-fetcher': 3,
166 'activitypub-cleaner': 1,
167 'activitypub-follow': 1,
168 'video-file-import': 1,
171 'videos-views-stats': 1,
172 'activitypub-refresher': 1,
173 'video-redundancy': 1,
174 'video-live-ending': 10,
175 'video-studio-edition': 1,
176 'manage-video-torrent': 1,
177 'move-to-object-storage': 1
179 const JOB_TTL: { [id in JobType]: number } = {
180 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
181 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
182 'activitypub-http-unicast': 60000 * 10, // 10 minutes
183 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
184 'activitypub-follow': 60000 * 10, // 10 minutes
185 'activitypub-cleaner': 1000 * 3600, // 1 hour
186 'video-file-import': 1000 * 3600, // 1 hour
187 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
188 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
189 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
190 'email': 60000 * 10, // 10 minutes
191 'actor-keys': 60000 * 20, // 20 minutes
192 'videos-views-stats': undefined, // Unlimited
193 'activitypub-refresher': 60000 * 10, // 10 minutes
194 'video-redundancy': 1000 * 3600 * 3, // 3 hours
195 'video-live-ending': 1000 * 60 * 10, // 10 minutes
196 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
197 'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours
199 const REPEAT_JOBS: { [ id in JobType ]?: EveryRepeatOptions | CronRepeatOptions } = {
200 'videos-views-stats': {
201 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
203 'activitypub-cleaner': {
204 cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
207 const JOB_PRIORITY = {
211 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
212 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
215 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
216 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
217 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
220 const REQUEST_TIMEOUTS = {
221 DEFAULT: 7000, // 7 seconds
222 FILE: 30000, // 30 seconds
223 REDUNDANCY: JOB_TTL['video-redundancy']
226 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
227 const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
229 const SCHEDULER_INTERVALS_MS = {
230 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
231 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
232 UPDATE_VIDEOS: 60000, // 1 minute
233 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
234 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
235 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
236 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
237 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
238 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
239 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
240 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
241 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
242 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 // 1 hour
245 // ---------------------------------------------------------------------------
247 const CONSTRAINTS_FIELDS = {
249 NAME: { min: 1, max: 120 }, // Length
250 DESCRIPTION: { min: 3, max: 1000 }, // Length
251 USERNAME: { min: 1, max: 50 }, // Length
252 PASSWORD: { min: 6, max: 255 }, // Length
253 VIDEO_QUOTA: { min: -1 },
254 VIDEO_QUOTA_DAILY: { min: -1 },
255 VIDEO_LANGUAGES: { max: 500 }, // Array length
256 BLOCKED_REASON: { min: 3, max: 250 } // Length
259 REASON: { min: 2, max: 3000 }, // Length
260 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
263 MESSAGE: { min: 2, max: 3000 } // Length
266 REASON: { min: 2, max: 300 } // Length
269 NAME: { min: 1, max: 120 }, // Length
270 DESCRIPTION: { min: 3, max: 1000 }, // Length
271 SUPPORT: { min: 3, max: 1000 }, // Length
272 URL: { min: 3, max: 2000 } // Length
276 EXTNAME: [ '.vtt', '.srt' ],
278 max: 20 * 1024 * 1024 // 20MB
283 URL: { min: 3, max: 2000 }, // Length
284 TORRENT_NAME: { min: 3, max: 255 }, // Length
286 EXTNAME: [ '.torrent' ],
288 max: 1024 * 200 // 200 KB
293 URL: { min: 3, max: 2000 } // Length
296 URL: { min: 3, max: 2000 } // Length
299 NAME: { min: 3, max: 120 }, // Length
300 LANGUAGE: { min: 1, max: 10 }, // Length
301 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
302 DESCRIPTION: { min: 3, max: 10000 }, // Length
303 SUPPORT: { min: 3, max: 1000 }, // Length
305 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
307 max: 4 * 1024 * 1024 // 4MB
310 EXTNAME: [] as string[],
311 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
312 DURATION: { min: 0 }, // Number
313 TAGS: { min: 0, max: 5 }, // Number of total tags
314 TAG: { min: 2, max: 30 }, // Length
317 DISLIKES: { min: 0 },
318 FILE_SIZE: { min: -1 },
319 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
320 URL: { min: 3, max: 2000 } // Length
323 NAME: { min: 1, max: 120 }, // Length
324 DESCRIPTION: { min: 3, max: 1000 }, // Length
325 URL: { min: 3, max: 2000 }, // Length
327 EXTNAME: [ '.jpg', '.jpeg' ],
329 max: 4 * 1024 * 1024 // 4MB
334 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
335 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
336 URL: { min: 3, max: 2000 }, // Length
338 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
340 max: 4 * 1024 * 1024 // 4MB
348 TEXT: { min: 1, max: 10000 }, // Length
349 URL: { min: 3, max: 2000 } // Length
352 URL: { min: 3, max: 2000 } // Length
355 FROM_NAME: { min: 1, max: 120 }, // Length
356 BODY: { min: 3, max: 5000 } // Length
359 NAME: { min: 1, max: 214 }, // Length
360 DESCRIPTION: { min: 1, max: 20000 } // Length
363 URL: { min: 5, max: 2000 } // Length
366 TASKS: { min: 1, max: 10 }, // Number of tasks
367 CUT_TIME: { min: 0 } // Value
370 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
371 CLIENT_STACK_TRACE: { min: 1, max: 5000 }, // Length
372 CLIENT_META: { min: 1, max: 5000 }, // Length
373 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
377 const VIEW_LIFETIME = {
378 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
379 VIEWER_COUNTER: 60000 * 2, // 2 minutes
380 VIEWER_STATS: 60000 * 60 // 1 hour
383 const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
385 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
387 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
389 STANDARD: [ 24, 25, 30 ],
390 HD_STANDARD: [ 50, 60 ],
394 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
397 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
399 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
404 const FFMPEG_NICE: { [ id: string ]: number } = {
405 // parent process defaults to niceness = 0
406 // reminder: lower = higher priority, max value is 19, lowest is -20
407 LIVE: 5, // prioritize over VOD and THUMBNAIL
412 const VIDEO_CATEGORIES = {
423 11: 'News & Politics',
427 15: 'Science & Technology',
433 // See https://creativecommons.org/licenses/?lang=en
434 const VIDEO_LICENCES = {
436 2: 'Attribution - Share Alike',
437 3: 'Attribution - No Derivatives',
438 4: 'Attribution - Non Commercial',
439 5: 'Attribution - Non Commercial - Share Alike',
440 6: 'Attribution - Non Commercial - No Derivatives',
441 7: 'Public Domain Dedication'
444 const VIDEO_LANGUAGES: { [id: string]: string } = {}
446 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
447 [VideoPrivacy.PUBLIC]: 'Public',
448 [VideoPrivacy.UNLISTED]: 'Unlisted',
449 [VideoPrivacy.PRIVATE]: 'Private',
450 [VideoPrivacy.INTERNAL]: 'Internal'
453 const VIDEO_STATES: { [ id in VideoState ]: string } = {
454 [VideoState.PUBLISHED]: 'Published',
455 [VideoState.TO_TRANSCODE]: 'To transcode',
456 [VideoState.TO_IMPORT]: 'To import',
457 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
458 [VideoState.LIVE_ENDED]: 'Livestream ended',
459 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
460 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
461 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
462 [VideoState.TO_EDIT]: 'To edit*'
465 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
466 [VideoImportState.FAILED]: 'Failed',
467 [VideoImportState.PENDING]: 'Pending',
468 [VideoImportState.SUCCESS]: 'Success',
469 [VideoImportState.REJECTED]: 'Rejected',
470 [VideoImportState.CANCELLED]: 'Cancelled',
471 [VideoImportState.PROCESSING]: 'Processing'
474 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
475 [AbuseState.PENDING]: 'Pending',
476 [AbuseState.REJECTED]: 'Rejected',
477 [AbuseState.ACCEPTED]: 'Accepted'
480 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
481 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
482 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
483 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
486 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
487 [VideoPlaylistType.REGULAR]: 'Regular',
488 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
494 'audio/mpeg': '.mp3',
497 'application/ogg': '.ogg',
500 'audio/x-ms-wma': '.wma',
502 'audio/x-wav': '.wav',
504 'audio/x-flac': '.flac',
505 'audio/flac': '.flac',
507 'audio/vnd.dlna.adts': '.aac',
512 'audio/x-m4a': '.m4a',
514 'audio/vnd.dolby.dd-raw': '.ac3',
517 EXT_MIMETYPE: null as { [ id: string ]: string }
520 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
521 MIMETYPES_REGEX: null as string,
522 EXT_MIMETYPE: null as { [ id: string ]: string }
528 'image/webp': '.webp',
532 EXT_MIMETYPE: null as { [ id: string ]: string }
537 'application/x-subrip': '.srt',
543 'application/x-bittorrent': '.torrent'
547 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
548 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
550 const BINARY_CONTENT_TYPES = new Set([
551 'binary/octet-stream',
552 'application/octet-stream',
553 'application/x-binary'
556 // ---------------------------------------------------------------------------
565 // ---------------------------------------------------------------------------
567 const SERVER_ACTOR_NAME = 'peertube'
569 const ACTIVITY_PUB = {
570 POTENTIAL_ACCEPT_HEADERS: [
571 'application/activity+json',
572 'application/ld+json',
573 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
575 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
576 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
577 COLLECTION_ITEMS_PER_PAGE: 10,
578 FETCH_PAGE_LIMIT: 2000,
580 VIDEO: [] as string[],
581 TORRENT: [ 'application/x-bittorrent' ],
582 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
584 MAX_RECURSION_COMMENTS: 100,
585 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
586 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
587 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
590 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
593 APPLICATION: 'Application',
594 ORGANIZATION: 'Organization',
598 const HTTP_SIGNATURE = {
599 HEADER_NAME: 'signature',
600 ALGORITHM: 'rsa-sha256',
601 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
602 CLOCK_SKEW_SECONDS: 1800
605 // ---------------------------------------------------------------------------
607 let PRIVATE_RSA_KEY_SIZE = 2048
609 // Password encryption
610 const BCRYPT_SALT_SIZE = 10
612 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
613 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
615 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
617 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
618 DO_NOT_LIST: 'do_not_list',
623 // ---------------------------------------------------------------------------
625 // Express static paths (router)
626 const STATIC_PATHS = {
627 THUMBNAILS: '/static/thumbnails/',
628 WEBSEED: '/static/webseed/',
629 REDUNDANCY: '/static/redundancy/',
630 STREAMING_PLAYLISTS: {
631 HLS: '/static/streaming-playlists/hls'
634 const STATIC_DOWNLOAD_PATHS = {
635 TORRENTS: '/download/torrents/',
636 VIDEOS: '/download/videos/',
637 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
639 const LAZY_STATIC_PATHS = {
640 BANNERS: '/lazy-static/banners/',
641 AVATARS: '/lazy-static/avatars/',
642 PREVIEWS: '/lazy-static/previews/',
643 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
644 TORRENTS: '/lazy-static/torrents/'
648 const STATIC_MAX_AGE = {
654 // Videos thumbnail size
655 const THUMBNAILS_SIZE = {
660 const PREVIEWS_SIZE = {
665 const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[]} = {
666 [ActorImageType.AVATAR]: [
676 [ActorImageType.BANNER]: [
679 height: 317 // 6/1 ratio
689 // Sub folders of cache directory
690 const FILES_CACHE = {
692 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
693 MAX_AGE: 1000 * 3600 * 3 // 3 hours
696 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
697 MAX_AGE: 1000 * 3600 * 3 // 3 hours
700 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
701 MAX_AGE: 1000 * 3600 * 3 // 3 hours
709 ACTOR_IMAGE_STATIC: {
714 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
715 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
716 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
718 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
722 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
723 SEGMENT_TIME_SECONDS: {
724 DEFAULT_LATENCY: 4, // 4 seconds
725 SMALL_LATENCY: 2 // 2 seconds
727 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
728 REPLAY_DIRECTORY: 'replay',
729 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
730 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
740 const MEMOIZE_TTL = {
741 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
742 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
743 VIDEO_DURATION: 1000 * 10, // 10 seconds
744 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
745 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
746 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
749 const MEMOIZE_LENGTH = {
750 INFO_HASH_EXISTS: 200,
754 const WORKER_THREADS = {
771 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
773 const ASSETS_PATH = {
774 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
775 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
778 // ---------------------------------------------------------------------------
780 const CUSTOM_HTML_TAG_COMMENTS = {
781 TITLE: '<!-- title tag -->',
782 DESCRIPTION: '<!-- description tag -->',
783 CUSTOM_CSS: '<!-- custom css tag -->',
784 META_TAGS: '<!-- meta tags -->',
785 SERVER_CONFIG: '<!-- server config -->'
788 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
789 const LOG_FILENAME = 'peertube.log'
790 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
792 // ---------------------------------------------------------------------------
794 const TRACKER_RATE_LIMITS = {
795 INTERVAL: 60000 * 5, // 5 minutes
796 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
797 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
798 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
801 const P2P_MEDIA_LOADER_PEER_VERSION = 2
803 // ---------------------------------------------------------------------------
805 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
806 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
808 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
810 const DEFAULT_THEME_NAME = 'default'
811 const DEFAULT_USER_THEME_NAME = 'instance-default'
813 // ---------------------------------------------------------------------------
815 const SEARCH_INDEX = {
817 VIDEOS: '/api/v1/search/videos',
818 VIDEO_CHANNELS: '/api/v1/search/video-channels'
822 // ---------------------------------------------------------------------------
824 const STATS_TIMESERIE = {
825 MAX_DAYS: 365 * 10 // Around 10 years
828 // ---------------------------------------------------------------------------
830 // Special constants for a test instance
831 if (process.env.PRODUCTION_CONSTANTS !== 'true') {
832 if (isTestOrDevInstance()) {
833 PRIVATE_RSA_KEY_SIZE = 1024
835 ACTOR_FOLLOW_SCORE.BASE = 20
837 REMOTE_SCHEME.HTTP = 'http'
838 REMOTE_SCHEME.WS = 'ws'
840 STATIC_MAX_AGE.SERVER = '0'
842 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
843 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
844 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
845 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
846 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
847 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
848 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
849 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
851 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
853 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
854 AP_CLEANER.PERIOD = 5000
856 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
858 CONTACT_FORM_LIFETIME = 1000 // 1 second
860 JOB_ATTEMPTS['email'] = 1
862 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
863 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
864 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
865 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
867 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
870 if (isTestInstance()) {
871 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
872 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
873 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
874 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
876 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
877 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
879 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
880 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
882 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
883 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
884 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
885 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
889 updateWebserverUrls()
890 updateWebserverConfig()
892 registerConfigChangedHandler(() => {
893 updateWebserverUrls()
894 updateWebserverConfig()
897 // ---------------------------------------------------------------------------
899 const FILES_CONTENT_HASH = {
900 MANIFEST: generateContentHash(),
901 FAVICON: generateContentHash(),
902 LOGO: generateContentHash()
905 // ---------------------------------------------------------------------------
907 const VIDEO_FILTERS = {
910 HORIZONTAL_MARGIN_RATIO: 1 / 20,
911 VERTICAL_MARGIN_RATIO: 1 / 20
915 // ---------------------------------------------------------------------------
924 RESUMABLE_UPLOAD_DIRECTORY,
925 RESUMABLE_UPLOAD_SESSION_LIFETIME,
926 HLS_REDUNDANCY_DIRECTORY,
927 P2P_MEDIA_LOADER_PEER_VERSION,
940 LAST_MIGRATION_VERSION,
942 CUSTOM_HTML_TAG_COMMENTS,
944 BROADCAST_CONCURRENCY,
951 DEFAULT_USER_THEME_NAME,
953 PLUGIN_GLOBAL_CSS_FILE_NAME,
954 PLUGIN_GLOBAL_CSS_PATH,
955 PRIVATE_RSA_KEY_SIZE,
957 ROUTE_CACHE_LIFETIME,
959 HLS_STREAMING_PLAYLIST_DIRECTORY,
965 VIDEO_IMPORT_TIMEOUT,
966 VIDEO_PLAYLIST_TYPES,
967 MAX_LOGS_OUTPUT_CHARACTERS,
969 ACTIVITY_PUB_ACTOR_TYPES,
980 VIDEO_TRANSCODING_FPS,
985 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
986 USER_PASSWORD_RESET_LIFETIME,
987 USER_PASSWORD_CREATE_LIFETIME,
989 USER_EMAIL_VERIFY_LIFETIME,
991 SCHEDULER_INTERVALS_MS,
993 STATIC_DOWNLOAD_PATHS,
995 CRAWL_REQUEST_CONCURRENCY,
996 DEFAULT_AUDIO_RESOLUTION,
997 BINARY_CONTENT_TYPES,
998 JOB_COMPLETED_LIFETIME,
1000 VIDEO_IMPORT_STATES,
1002 CONTACT_FORM_LIFETIME,
1003 VIDEO_PLAYLIST_PRIVACIES,
1004 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
1012 // ---------------------------------------------------------------------------
1014 function buildVideoMimetypeExt () {
1016 // streamable formats that warrant cross-browser compatibility
1017 'video/webm': '.webm',
1018 // We'll add .ogg if additional extensions are enabled
1019 // We could add .ogg here but since it could be an audio file,
1020 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1021 'video/ogg': [ '.ogv' ],
1025 if (CONFIG.TRANSCODING.ENABLED) {
1026 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
1027 data['video/ogg'].push('.ogg')
1029 Object.assign(data, {
1030 'video/x-matroska': '.mkv',
1032 // Developed by Apple
1033 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
1034 'video/x-m4v': '.m4v',
1035 'video/m4v': '.m4v',
1037 // Developed by the Adobe Flash Platform
1038 'video/x-flv': '.flv',
1039 'video/x-f4v': '.f4v', // replacement for flv
1041 // Developed by Microsoft
1042 'video/x-ms-wmv': '.wmv',
1043 'video/x-msvideo': '.avi',
1044 'video/avi': '.avi',
1046 // Developed by 3GPP
1047 // common video formats for cell phones
1048 'video/3gpp': [ '.3gp', '.3gpp' ],
1049 'video/3gpp2': [ '.3g2', '.3gpp2' ],
1051 // Developed by FFmpeg/Mplayer
1052 'application/x-nut': '.nut',
1054 // The standard video format used by many Sony and Panasonic HD camcorders.
1055 // It is also used for storing high definition video on Blu-ray discs.
1056 'video/mp2t': '.mts',
1057 'video/vnd.dlna.mpeg-tts': '.mts',
1059 'video/m2ts': '.m2ts',
1061 // Old formats reliant on MPEG-1/MPEG-2
1062 'video/mpv': '.mpv',
1063 'video/mpeg2': '.m2v',
1064 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1065 'video/dvd': '.vob',
1067 // Could be anything
1068 'application/octet-stream': null,
1069 'application/mxf': '.mxf' // often used as exchange format by editing software
1073 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1074 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1081 function updateWebserverUrls () {
1082 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1083 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
1084 WEBSERVER.WS = CONFIG.WEBSERVER.WS
1086 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
1087 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1088 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1090 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1091 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1093 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1094 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1097 function updateWebserverConfig () {
1098 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1099 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1101 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1103 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1105 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1108 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1109 const result: { [id: string]: string } = {}
1111 for (const mimetype of Object.keys(obj)) {
1112 const value = obj[mimetype]
1113 if (!value) continue
1115 const extensions = Array.isArray(value) ? value : [ value ]
1117 for (const extension of extensions) {
1118 result[extension] = mimetype
1125 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1126 return Object.keys(obj)
1131 function loadLanguages () {
1132 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1135 function buildLanguages () {
1136 const iso639 = require('iso-639-3')
1138 const languages: { [id: string]: string } = {}
1140 const additionalLanguages = {
1141 sgn: true, // Sign languages (macro language)
1142 ase: true, // American sign language
1143 sdl: true, // Arabian sign language
1144 bfi: true, // British sign language
1145 bzs: true, // Brazilian sign language
1146 csl: true, // Chinese sign language
1147 cse: true, // Czech sign language
1148 dsl: true, // Danish sign language
1149 fsl: true, // French sign language
1150 gsg: true, // German sign language
1151 pks: true, // Pakistan sign language
1152 jsl: true, // Japanese sign language
1153 sfs: true, // South African sign language
1154 swl: true, // Swedish sign language
1155 rsl: true, // Russian sign language
1157 kab: true, // Kabyle
1161 epo: true, // Esperanto
1162 tlh: true, // Klingon
1163 jbo: true, // Lojban
1164 avk: true, // Kotava
1166 zxx: true // No linguistic content (ISO-639-2)
1169 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1172 return (l.iso6391 !== undefined && l.type === 'living') ||
1173 additionalLanguages[l.iso6393] === true
1175 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1177 // Override Occitan label
1178 languages['oc'] = 'Occitan'
1179 languages['el'] = 'Greek'
1180 languages['tok'] = 'Toki Pona'
1182 // Chinese languages
1183 languages['zh-Hans'] = 'Simplified Chinese'
1184 languages['zh-Hant'] = 'Traditional Chinese'
1189 function generateContentHash () {
1190 return randomBytes(20).toString('hex')
1193 function getIntEnv (path: string) {
1194 if (process.env[path]) return parseInt(process.env[path])