1 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
2 import { randomBytes } from 'crypto'
3 import { invert } from 'lodash'
4 import { join } from 'path'
5 import { randomInt } from '../../shared/core-utils/common/miscs'
15 } from '../../shared/models'
16 import { ActivityPubActorType } from '../../shared/models/activitypub'
17 import { 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, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
23 import { CONFIG, registerConfigChangedHandler } from './config'
25 // ---------------------------------------------------------------------------
27 const LAST_MIGRATION_VERSION = 670
29 // ---------------------------------------------------------------------------
31 const API_VERSION = 'v1'
32 const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
58 // Sortable columns per schema
59 const SORTABLE_COLUMNS = {
60 USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
61 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
62 ACCOUNTS: [ 'createdAt' ],
63 JOBS: [ 'createdAt' ],
64 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
65 VIDEO_IMPORTS: [ 'createdAt' ],
67 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
68 VIDEO_COMMENTS: [ 'createdAt' ],
70 VIDEO_RATES: [ 'createdAt' ],
71 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
73 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
74 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
75 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
76 CHANNEL_FOLLOWERS: [ 'createdAt' ],
78 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
80 // Don't forget to update peertube-search-index with the same values
81 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
82 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
83 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
85 ABUSES: [ 'id', 'createdAt', 'state' ],
87 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
88 SERVERS_BLOCKLIST: [ 'createdAt' ],
90 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
92 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
94 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
96 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
98 VIDEO_REDUNDANCIES: [ 'name' ]
101 const OAUTH_LIFETIME = {
102 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
103 REFRESH_TOKEN: 1209600 // 2 weeks
106 const ROUTE_CACHE_LIFETIME = {
110 SECURITYTXT: '2 hours',
111 NODEINFO: '10 minutes',
112 DNT_POLICY: '1 week',
114 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
119 // ---------------------------------------------------------------------------
121 // Number of points we add/remove after a successful/bad request
122 const ACTOR_FOLLOW_SCORE = {
129 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
134 const REMOTE_SCHEME = {
139 const JOB_ATTEMPTS: { [id in JobType]: number } = {
140 'activitypub-http-broadcast': 1,
141 'activitypub-http-unicast': 1,
142 'activitypub-http-fetcher': 2,
143 'activitypub-follow': 5,
144 'activitypub-cleaner': 1,
145 'video-file-import': 1,
146 'video-transcoding': 1,
151 'activitypub-refresher': 1,
152 'video-redundancy': 1,
153 'video-live-ending': 1,
154 'move-to-object-storage': 3
156 // Excluded keys are jobs that can be configured by admins
157 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
158 'activitypub-http-broadcast': 1,
159 'activitypub-http-unicast': 10,
160 'activitypub-http-fetcher': 3,
161 'activitypub-cleaner': 1,
162 'activitypub-follow': 1,
163 'video-file-import': 1,
167 'activitypub-refresher': 1,
168 'video-redundancy': 1,
169 'video-live-ending': 10,
170 'move-to-object-storage': 1
172 const JOB_TTL: { [id in JobType]: number } = {
173 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
174 'activitypub-http-unicast': 60000 * 10, // 10 minutes
175 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
176 'activitypub-follow': 60000 * 10, // 10 minutes
177 'activitypub-cleaner': 1000 * 3600, // 1 hour
178 'video-file-import': 1000 * 3600, // 1 hour
179 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
180 'video-import': 1000 * 3600 * 2, // 2 hours
181 'email': 60000 * 10, // 10 minutes
182 'actor-keys': 60000 * 20, // 20 minutes
183 'videos-views': undefined, // Unlimited
184 'activitypub-refresher': 60000 * 10, // 10 minutes
185 'video-redundancy': 1000 * 3600 * 3, // 3 hours
186 'video-live-ending': 1000 * 60 * 10, // 10 minutes
187 'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours
189 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
191 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
193 'activitypub-cleaner': {
194 cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
197 const JOB_PRIORITY = {
201 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
202 const AP_CLEANER_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-cleaner job
203 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
204 const REQUEST_TIMEOUT = 7000 // 7 seconds
205 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
206 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
208 const SCHEDULER_INTERVALS_MS = {
209 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
210 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
211 UPDATE_VIDEOS: 60000, // 1 minute
212 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
213 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
214 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
215 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
216 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
217 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
218 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
219 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 * 16 // 16 hours
222 // ---------------------------------------------------------------------------
224 const CONSTRAINTS_FIELDS = {
226 NAME: { min: 1, max: 120 }, // Length
227 DESCRIPTION: { min: 3, max: 1000 }, // Length
228 USERNAME: { min: 1, max: 50 }, // Length
229 PASSWORD: { min: 6, max: 255 }, // Length
230 VIDEO_QUOTA: { min: -1 },
231 VIDEO_QUOTA_DAILY: { min: -1 },
232 VIDEO_LANGUAGES: { max: 500 }, // Array length
233 BLOCKED_REASON: { min: 3, max: 250 } // Length
236 REASON: { min: 2, max: 3000 }, // Length
237 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
240 MESSAGE: { min: 2, max: 3000 } // Length
243 REASON: { min: 2, max: 300 } // Length
246 NAME: { min: 1, max: 120 }, // Length
247 DESCRIPTION: { min: 3, max: 1000 }, // Length
248 SUPPORT: { min: 3, max: 1000 }, // Length
249 URL: { min: 3, max: 2000 } // Length
253 EXTNAME: [ '.vtt', '.srt' ],
255 max: 4 * 1024 * 1024 // 4MB
260 URL: { min: 3, max: 2000 }, // Length
261 TORRENT_NAME: { min: 3, max: 255 }, // Length
263 EXTNAME: [ '.torrent' ],
265 max: 1024 * 200 // 200 KB
270 URL: { min: 3, max: 2000 } // Length
273 URL: { min: 3, max: 2000 } // Length
276 NAME: { min: 3, max: 120 }, // Length
277 LANGUAGE: { min: 1, max: 10 }, // Length
278 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
279 DESCRIPTION: { min: 3, max: 10000 }, // Length
280 SUPPORT: { min: 3, max: 1000 }, // Length
282 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
284 max: 4 * 1024 * 1024 // 4MB
287 EXTNAME: [] as string[],
288 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
289 DURATION: { min: 0 }, // Number
290 TAGS: { min: 0, max: 5 }, // Number of total tags
291 TAG: { min: 2, max: 30 }, // Length
294 DISLIKES: { min: 0 },
295 FILE_SIZE: { min: -1 },
296 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
297 URL: { min: 3, max: 2000 } // Length
300 NAME: { min: 1, max: 120 }, // Length
301 DESCRIPTION: { min: 3, max: 1000 }, // Length
302 URL: { min: 3, max: 2000 }, // Length
304 EXTNAME: [ '.jpg', '.jpeg' ],
306 max: 4 * 1024 * 1024 // 4MB
311 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
312 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
313 URL: { min: 3, max: 2000 }, // Length
315 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
317 max: 4 * 1024 * 1024 // 4MB
325 TEXT: { min: 1, max: 10000 }, // Length
326 URL: { min: 3, max: 2000 } // Length
329 URL: { min: 3, max: 2000 } // Length
332 FROM_NAME: { min: 1, max: 120 }, // Length
333 BODY: { min: 3, max: 5000 } // Length
336 NAME: { min: 1, max: 214 }, // Length
337 DESCRIPTION: { min: 1, max: 20000 } // Length
340 URL: { min: 5, max: 2000 } // Length
344 const VIEW_LIFETIME = {
345 VIDEO: 60000 * 60, // 1 hour
346 LIVE: 60000 * 5 // 5 minutes
349 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
351 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
353 STANDARD: [ 24, 25, 30 ],
354 HD_STANDARD: [ 50, 60 ],
357 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
360 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
362 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
367 const FFMPEG_NICE: { [ id: string ]: number } = {
368 // parent process defaults to niceness = 0
369 // reminder: lower = higher priority, max value is 19, lowest is -20
370 LIVE: 5, // prioritize over VOD and THUMBNAIL
375 const VIDEO_CATEGORIES = {
386 11: 'News & Politics',
390 15: 'Science & Technology',
396 // See https://creativecommons.org/licenses/?lang=en
397 const VIDEO_LICENCES = {
399 2: 'Attribution - Share Alike',
400 3: 'Attribution - No Derivatives',
401 4: 'Attribution - Non Commercial',
402 5: 'Attribution - Non Commercial - Share Alike',
403 6: 'Attribution - Non Commercial - No Derivatives',
404 7: 'Public Domain Dedication'
407 const VIDEO_LANGUAGES: { [id: string]: string } = {}
409 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
410 [VideoPrivacy.PUBLIC]: 'Public',
411 [VideoPrivacy.UNLISTED]: 'Unlisted',
412 [VideoPrivacy.PRIVATE]: 'Private',
413 [VideoPrivacy.INTERNAL]: 'Internal'
416 const VIDEO_STATES: { [ id in VideoState ]: string } = {
417 [VideoState.PUBLISHED]: 'Published',
418 [VideoState.TO_TRANSCODE]: 'To transcode',
419 [VideoState.TO_IMPORT]: 'To import',
420 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
421 [VideoState.LIVE_ENDED]: 'Livestream ended',
422 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage'
425 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
426 [VideoImportState.FAILED]: 'Failed',
427 [VideoImportState.PENDING]: 'Pending',
428 [VideoImportState.SUCCESS]: 'Success',
429 [VideoImportState.REJECTED]: 'Rejected'
432 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
433 [AbuseState.PENDING]: 'Pending',
434 [AbuseState.REJECTED]: 'Rejected',
435 [AbuseState.ACCEPTED]: 'Accepted'
438 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
439 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
440 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
441 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
444 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
445 [VideoPlaylistType.REGULAR]: 'Regular',
446 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
452 'audio/mpeg': '.mp3',
454 'application/ogg': '.ogg',
456 'audio/x-ms-wma': '.wma',
458 'audio/x-wav': '.wav',
459 'audio/x-flac': '.flac',
460 'audio/flac': '.flac',
464 'audio/x-m4a': '.m4a',
467 EXT_MIMETYPE: null as { [ id: string ]: string }
470 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
471 MIMETYPES_REGEX: null as string,
472 EXT_MIMETYPE: null as { [ id: string ]: string }
478 'image/webp': '.webp',
482 EXT_MIMETYPE: null as { [ id: string ]: string }
487 'application/x-subrip': '.srt',
493 'application/x-bittorrent': '.torrent'
497 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
498 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
500 const BINARY_CONTENT_TYPES = new Set([
501 'binary/octet-stream',
502 'application/octet-stream',
503 'application/x-binary'
506 // ---------------------------------------------------------------------------
515 const VIDEO_CHANNELS = {
519 // ---------------------------------------------------------------------------
521 const SERVER_ACTOR_NAME = 'peertube'
523 const ACTIVITY_PUB = {
524 POTENTIAL_ACCEPT_HEADERS: [
525 'application/activity+json',
526 'application/ld+json',
527 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
529 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
530 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
531 COLLECTION_ITEMS_PER_PAGE: 10,
532 FETCH_PAGE_LIMIT: 2000,
534 VIDEO: [] as string[],
535 TORRENT: [ 'application/x-bittorrent' ],
536 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
538 MAX_RECURSION_COMMENTS: 100,
539 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
540 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
541 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
544 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
547 APPLICATION: 'Application',
548 ORGANIZATION: 'Organization',
552 const HTTP_SIGNATURE = {
553 HEADER_NAME: 'signature',
554 ALGORITHM: 'rsa-sha256',
555 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
557 ALL: [ '(request-target)', 'host', 'date' ],
558 POST: [ '(request-target)', 'host', 'date', 'digest' ]
560 CLOCK_SKEW_SECONDS: 1800
563 // ---------------------------------------------------------------------------
565 let PRIVATE_RSA_KEY_SIZE = 2048
567 // Password encryption
568 const BCRYPT_SALT_SIZE = 10
570 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
571 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
573 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
575 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
576 DO_NOT_LIST: 'do_not_list',
581 // ---------------------------------------------------------------------------
583 // Express static paths (router)
584 const STATIC_PATHS = {
585 THUMBNAILS: '/static/thumbnails/',
586 WEBSEED: '/static/webseed/',
587 REDUNDANCY: '/static/redundancy/',
588 STREAMING_PLAYLISTS: {
589 HLS: '/static/streaming-playlists/hls'
592 const STATIC_DOWNLOAD_PATHS = {
593 TORRENTS: '/download/torrents/',
594 VIDEOS: '/download/videos/',
595 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
597 const LAZY_STATIC_PATHS = {
598 BANNERS: '/lazy-static/banners/',
599 AVATARS: '/lazy-static/avatars/',
600 PREVIEWS: '/lazy-static/previews/',
601 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
602 TORRENTS: '/lazy-static/torrents/'
606 const STATIC_MAX_AGE = {
612 // Videos thumbnail size
613 const THUMBNAILS_SIZE = {
618 const PREVIEWS_SIZE = {
623 const ACTOR_IMAGES_SIZE = {
630 height: 317 // 6/1 ratio
639 // Sub folders of cache directory
640 const FILES_CACHE = {
642 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
643 MAX_AGE: 1000 * 3600 * 3 // 3 hours
646 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
647 MAX_AGE: 1000 * 3600 * 3 // 3 hours
650 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
651 MAX_AGE: 1000 * 3600 * 3 // 3 hours
659 ACTOR_IMAGE_STATIC: {
664 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
665 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
666 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
670 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
671 SEGMENT_TIME_SECONDS: 4, // 4 seconds
672 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
673 REPLAY_DIRECTORY: 'replay',
674 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
675 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
685 const MEMOIZE_TTL = {
686 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
687 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
688 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
689 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
692 const MEMOIZE_LENGTH = {
693 INFO_HASH_EXISTS: 200
696 const QUEUE_CONCURRENCY = {
697 ACTOR_PROCESS_IMAGE: 3
706 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
708 const ASSETS_PATH = {
709 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
710 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
713 // ---------------------------------------------------------------------------
715 const CUSTOM_HTML_TAG_COMMENTS = {
716 TITLE: '<!-- title tag -->',
717 DESCRIPTION: '<!-- description tag -->',
718 CUSTOM_CSS: '<!-- custom css tag -->',
719 META_TAGS: '<!-- meta tags -->',
720 SERVER_CONFIG: '<!-- server config -->'
723 // ---------------------------------------------------------------------------
729 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
730 const LOG_FILENAME = 'peertube.log'
731 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
733 // ---------------------------------------------------------------------------
735 const TRACKER_RATE_LIMITS = {
736 INTERVAL: 60000 * 5, // 5 minutes
737 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
738 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
739 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
742 const P2P_MEDIA_LOADER_PEER_VERSION = 2
744 // ---------------------------------------------------------------------------
746 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
747 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
749 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
751 const DEFAULT_THEME_NAME = 'default'
752 const DEFAULT_USER_THEME_NAME = 'instance-default'
754 // ---------------------------------------------------------------------------
756 const SEARCH_INDEX = {
758 VIDEOS: '/api/v1/search/videos',
759 VIDEO_CHANNELS: '/api/v1/search/video-channels'
763 // ---------------------------------------------------------------------------
765 // Special constants for a test instance
766 if (isTestInstance() === true) {
767 PRIVATE_RSA_KEY_SIZE = 1024
769 ACTOR_FOLLOW_SCORE.BASE = 20
771 REMOTE_SCHEME.HTTP = 'http'
772 REMOTE_SCHEME.WS = 'ws'
774 STATIC_MAX_AGE.SERVER = '0'
776 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
777 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
778 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
779 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
781 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
782 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
784 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
785 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
786 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
787 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
788 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
789 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
790 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
791 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
792 REPEAT_JOBS['videos-views'] = { every: 5000 }
793 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
795 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
797 VIEW_LIFETIME.VIDEO = 1000 // 1 second
798 VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
799 CONTACT_FORM_LIFETIME = 1000 // 1 second
801 JOB_ATTEMPTS['email'] = 1
803 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
804 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
805 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
806 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
808 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
810 VIDEO_LIVE.CLEANUP_DELAY = 5000
811 VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
812 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
815 updateWebserverUrls()
816 updateWebserverConfig()
818 registerConfigChangedHandler(() => {
819 updateWebserverUrls()
820 updateWebserverConfig()
823 // ---------------------------------------------------------------------------
825 const FILES_CONTENT_HASH = {
826 MANIFEST: generateContentHash(),
827 FAVICON: generateContentHash(),
828 LOGO: generateContentHash()
831 // ---------------------------------------------------------------------------
840 RESUMABLE_UPLOAD_DIRECTORY,
841 HLS_REDUNDANCY_DIRECTORY,
842 P2P_MEDIA_LOADER_PEER_VERSION,
854 AP_CLEANER_CONCURRENCY,
855 LAST_MIGRATION_VERSION,
857 CUSTOM_HTML_TAG_COMMENTS,
858 BROADCAST_CONCURRENCY,
865 DEFAULT_USER_THEME_NAME,
867 PLUGIN_GLOBAL_CSS_FILE_NAME,
868 PLUGIN_GLOBAL_CSS_PATH,
869 PRIVATE_RSA_KEY_SIZE,
870 ROUTE_CACHE_LIFETIME,
872 HLS_STREAMING_PLAYLIST_DIRECTORY,
879 VIDEO_IMPORT_TIMEOUT,
880 VIDEO_PLAYLIST_TYPES,
881 MAX_LOGS_OUTPUT_CHARACTERS,
883 ACTIVITY_PUB_ACTOR_TYPES,
894 VIDEO_TRANSCODING_FPS,
900 USER_PASSWORD_RESET_LIFETIME,
901 USER_PASSWORD_CREATE_LIFETIME,
903 USER_EMAIL_VERIFY_LIFETIME,
905 SCHEDULER_INTERVALS_MS,
907 STATIC_DOWNLOAD_PATHS,
909 CRAWL_REQUEST_CONCURRENCY,
910 DEFAULT_AUDIO_RESOLUTION,
911 BINARY_CONTENT_TYPES,
912 JOB_COMPLETED_LIFETIME,
916 CONTACT_FORM_LIFETIME,
917 VIDEO_PLAYLIST_PRIVACIES,
918 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
926 // ---------------------------------------------------------------------------
928 function buildVideoMimetypeExt () {
930 // streamable formats that warrant cross-browser compatibility
931 'video/webm': '.webm',
932 // We'll add .ogg if additional extensions are enabled
933 // We could add .ogg here but since it could be an audio file,
934 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
935 'video/ogg': [ '.ogv' ],
939 if (CONFIG.TRANSCODING.ENABLED) {
940 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
941 data['video/ogg'].push('.ogg')
943 Object.assign(data, {
944 'video/x-matroska': '.mkv',
946 // Developed by Apple
947 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
948 'video/x-m4v': '.m4v',
951 // Developed by the Adobe Flash Platform
952 'video/x-flv': '.flv',
953 'video/x-f4v': '.f4v', // replacement for flv
955 // Developed by Microsoft
956 'video/x-ms-wmv': '.wmv',
957 'video/x-msvideo': '.avi',
961 // common video formats for cell phones
962 'video/3gpp': [ '.3gp', '.3gpp' ],
963 'video/3gpp2': [ '.3g2', '.3gpp2' ],
965 // Developed by FFmpeg/Mplayer
966 'application/x-nut': '.nut',
968 // The standard video format used by many Sony and Panasonic HD camcorders.
969 // It is also used for storing high definition video on Blu-ray discs.
970 'video/mp2t': '.mts',
971 'video/m2ts': '.m2ts',
973 // Old formats reliant on MPEG-1/MPEG-2
975 'video/mpeg2': '.m2v',
976 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
980 'application/octet-stream': null,
981 'application/mxf': '.mxf' // often used as exchange format by editing software
985 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
986 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
993 function updateWebserverUrls () {
994 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
995 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
996 WEBSERVER.WS = CONFIG.WEBSERVER.WS
998 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
999 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1000 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1002 WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1005 function updateWebserverConfig () {
1006 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1007 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1009 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1011 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1013 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1016 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1017 const result: { [id: string]: string } = {}
1019 for (const mimetype of Object.keys(obj)) {
1020 const value = obj[mimetype]
1021 if (!value) continue
1023 const extensions = Array.isArray(value) ? value : [ value ]
1025 for (const extension of extensions) {
1026 result[extension] = mimetype
1033 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1034 return Object.keys(obj)
1039 function loadLanguages () {
1040 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1043 function buildLanguages () {
1044 const iso639 = require('iso-639-3')
1046 const languages: { [id: string]: string } = {}
1048 const additionalLanguages = {
1049 sgn: true, // Sign languages (macro language)
1050 ase: true, // American sign language
1051 sdl: true, // Arabian sign language
1052 bfi: true, // British sign language
1053 bzs: true, // Brazilian sign language
1054 csl: true, // Chinese sign language
1055 cse: true, // Czech sign language
1056 dsl: true, // Danish sign language
1057 fsl: true, // French sign language
1058 gsg: true, // German sign language
1059 pks: true, // Pakistan sign language
1060 jsl: true, // Japanese sign language
1061 sfs: true, // South African sign language
1062 swl: true, // Swedish sign language
1063 rsl: true, // Russian sign language
1065 kab: true, // Kabyle
1069 epo: true, // Esperanto
1070 tlh: true, // Klingon
1071 jbo: true, // Lojban
1075 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1078 return (l.iso6391 !== undefined && l.type === 'living') ||
1079 additionalLanguages[l.iso6393] === true
1081 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1083 // Override Occitan label
1084 languages['oc'] = 'Occitan'
1085 languages['el'] = 'Greek'
1090 function generateContentHash () {
1091 return randomBytes(20).toString('hex')