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
59 // Sortable columns per schema
60 const SORTABLE_COLUMNS = {
61 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-unicast': 1,
143 'activitypub-http-fetcher': 2,
144 'activitypub-follow': 5,
145 'activitypub-cleaner': 1,
146 'video-file-import': 1,
147 'video-transcoding': 1,
152 'activitypub-refresher': 1,
153 'video-redundancy': 1,
154 'video-live-ending': 1,
155 'move-to-object-storage': 3
157 // Excluded keys are jobs that can be configured by admins
158 const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
159 'activitypub-http-broadcast': 1,
160 'activitypub-http-unicast': 10,
161 'activitypub-http-fetcher': 3,
162 'activitypub-cleaner': 1,
163 'activitypub-follow': 1,
164 'video-file-import': 1,
168 'activitypub-refresher': 1,
169 'video-redundancy': 1,
170 'video-live-ending': 10,
171 'move-to-object-storage': 1
173 const JOB_TTL: { [id in JobType]: number } = {
174 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
175 'activitypub-http-unicast': 60000 * 10, // 10 minutes
176 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
177 'activitypub-follow': 60000 * 10, // 10 minutes
178 'activitypub-cleaner': 1000 * 3600, // 1 hour
179 'video-file-import': 1000 * 3600, // 1 hour
180 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
181 'video-import': 1000 * 3600 * 2, // 2 hours
182 'email': 60000 * 10, // 10 minutes
183 'actor-keys': 60000 * 20, // 20 minutes
184 'videos-views': undefined, // Unlimited
185 'activitypub-refresher': 60000 * 10, // 10 minutes
186 'video-redundancy': 1000 * 3600 * 3, // 3 hours
187 'video-live-ending': 1000 * 60 * 10, // 10 minutes
188 'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours
190 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
192 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
194 'activitypub-cleaner': {
195 cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
198 const JOB_PRIORITY = {
202 const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
203 const AP_CLEANER_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-cleaner job
204 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
205 const REQUEST_TIMEOUT = 7000 // 7 seconds
206 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
207 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
209 const SCHEDULER_INTERVALS_MS = {
210 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
211 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
212 UPDATE_VIDEOS: 60000, // 1 minute
213 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
214 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
215 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
216 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
217 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
218 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
219 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
220 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 * 16 // 16 hours
223 // ---------------------------------------------------------------------------
225 const CONSTRAINTS_FIELDS = {
227 NAME: { min: 1, max: 120 }, // Length
228 DESCRIPTION: { min: 3, max: 1000 }, // Length
229 USERNAME: { min: 1, max: 50 }, // Length
230 PASSWORD: { min: 6, max: 255 }, // Length
231 VIDEO_QUOTA: { min: -1 },
232 VIDEO_QUOTA_DAILY: { min: -1 },
233 VIDEO_LANGUAGES: { max: 500 }, // Array length
234 BLOCKED_REASON: { min: 3, max: 250 } // Length
237 REASON: { min: 2, max: 3000 }, // Length
238 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
241 MESSAGE: { min: 2, max: 3000 } // Length
244 REASON: { min: 2, max: 300 } // Length
247 NAME: { min: 1, max: 120 }, // Length
248 DESCRIPTION: { min: 3, max: 1000 }, // Length
249 SUPPORT: { min: 3, max: 1000 }, // Length
250 URL: { min: 3, max: 2000 } // Length
254 EXTNAME: [ '.vtt', '.srt' ],
256 max: 4 * 1024 * 1024 // 4MB
261 URL: { min: 3, max: 2000 }, // Length
262 TORRENT_NAME: { min: 3, max: 255 }, // Length
264 EXTNAME: [ '.torrent' ],
266 max: 1024 * 200 // 200 KB
271 URL: { min: 3, max: 2000 } // Length
274 URL: { min: 3, max: 2000 } // Length
277 NAME: { min: 3, max: 120 }, // Length
278 LANGUAGE: { min: 1, max: 10 }, // Length
279 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
280 DESCRIPTION: { min: 3, max: 10000 }, // Length
281 SUPPORT: { min: 3, max: 1000 }, // Length
283 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
285 max: 4 * 1024 * 1024 // 4MB
288 EXTNAME: [] as string[],
289 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
290 DURATION: { min: 0 }, // Number
291 TAGS: { min: 0, max: 5 }, // Number of total tags
292 TAG: { min: 2, max: 30 }, // Length
295 DISLIKES: { min: 0 },
296 FILE_SIZE: { min: -1 },
297 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
298 URL: { min: 3, max: 2000 } // Length
301 NAME: { min: 1, max: 120 }, // Length
302 DESCRIPTION: { min: 3, max: 1000 }, // Length
303 URL: { min: 3, max: 2000 }, // Length
305 EXTNAME: [ '.jpg', '.jpeg' ],
307 max: 4 * 1024 * 1024 // 4MB
312 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
313 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
314 URL: { min: 3, max: 2000 }, // Length
316 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
318 max: 4 * 1024 * 1024 // 4MB
326 TEXT: { min: 1, max: 10000 }, // Length
327 URL: { min: 3, max: 2000 } // Length
330 URL: { min: 3, max: 2000 } // Length
333 FROM_NAME: { min: 1, max: 120 }, // Length
334 BODY: { min: 3, max: 5000 } // Length
337 NAME: { min: 1, max: 214 }, // Length
338 DESCRIPTION: { min: 1, max: 20000 } // Length
341 URL: { min: 5, max: 2000 } // Length
345 const VIEW_LIFETIME = {
346 VIDEO: 60000 * 60, // 1 hour
347 LIVE: 60000 * 5 // 5 minutes
350 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
352 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
354 STANDARD: [ 24, 25, 30 ],
355 HD_STANDARD: [ 50, 60 ],
358 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
361 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
363 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
368 const FFMPEG_NICE: { [ id: string ]: number } = {
369 // parent process defaults to niceness = 0
370 // reminder: lower = higher priority, max value is 19, lowest is -20
371 LIVE: 5, // prioritize over VOD and THUMBNAIL
376 const VIDEO_CATEGORIES = {
387 11: 'News & Politics',
391 15: 'Science & Technology',
397 // See https://creativecommons.org/licenses/?lang=en
398 const VIDEO_LICENCES = {
400 2: 'Attribution - Share Alike',
401 3: 'Attribution - No Derivatives',
402 4: 'Attribution - Non Commercial',
403 5: 'Attribution - Non Commercial - Share Alike',
404 6: 'Attribution - Non Commercial - No Derivatives',
405 7: 'Public Domain Dedication'
408 const VIDEO_LANGUAGES: { [id: string]: string } = {}
410 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
411 [VideoPrivacy.PUBLIC]: 'Public',
412 [VideoPrivacy.UNLISTED]: 'Unlisted',
413 [VideoPrivacy.PRIVATE]: 'Private',
414 [VideoPrivacy.INTERNAL]: 'Internal'
417 const VIDEO_STATES: { [ id in VideoState ]: string } = {
418 [VideoState.PUBLISHED]: 'Published',
419 [VideoState.TO_TRANSCODE]: 'To transcode',
420 [VideoState.TO_IMPORT]: 'To import',
421 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
422 [VideoState.LIVE_ENDED]: 'Livestream ended',
423 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage'
426 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
427 [VideoImportState.FAILED]: 'Failed',
428 [VideoImportState.PENDING]: 'Pending',
429 [VideoImportState.SUCCESS]: 'Success',
430 [VideoImportState.REJECTED]: 'Rejected'
433 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
434 [AbuseState.PENDING]: 'Pending',
435 [AbuseState.REJECTED]: 'Rejected',
436 [AbuseState.ACCEPTED]: 'Accepted'
439 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
440 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
441 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
442 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
445 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
446 [VideoPlaylistType.REGULAR]: 'Regular',
447 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
453 'audio/mpeg': '.mp3',
455 'application/ogg': '.ogg',
457 'audio/x-ms-wma': '.wma',
459 'audio/x-wav': '.wav',
460 'audio/x-flac': '.flac',
461 'audio/flac': '.flac',
465 'audio/x-m4a': '.m4a',
468 EXT_MIMETYPE: null as { [ id: string ]: string }
471 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
472 MIMETYPES_REGEX: null as string,
473 EXT_MIMETYPE: null as { [ id: string ]: string }
479 'image/webp': '.webp',
483 EXT_MIMETYPE: null as { [ id: string ]: string }
488 'application/x-subrip': '.srt',
494 'application/x-bittorrent': '.torrent'
498 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
499 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
501 const BINARY_CONTENT_TYPES = new Set([
502 'binary/octet-stream',
503 'application/octet-stream',
504 'application/x-binary'
507 // ---------------------------------------------------------------------------
516 // ---------------------------------------------------------------------------
518 const SERVER_ACTOR_NAME = 'peertube'
520 const ACTIVITY_PUB = {
521 POTENTIAL_ACCEPT_HEADERS: [
522 'application/activity+json',
523 'application/ld+json',
524 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
526 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
527 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
528 COLLECTION_ITEMS_PER_PAGE: 10,
529 FETCH_PAGE_LIMIT: 2000,
531 VIDEO: [] as string[],
532 TORRENT: [ 'application/x-bittorrent' ],
533 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
535 MAX_RECURSION_COMMENTS: 100,
536 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
537 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
538 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
541 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
544 APPLICATION: 'Application',
545 ORGANIZATION: 'Organization',
549 const HTTP_SIGNATURE = {
550 HEADER_NAME: 'signature',
551 ALGORITHM: 'rsa-sha256',
552 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
554 ALL: [ '(request-target)', 'host', 'date' ],
555 POST: [ '(request-target)', 'host', 'date', 'digest' ]
557 CLOCK_SKEW_SECONDS: 1800
560 // ---------------------------------------------------------------------------
562 let PRIVATE_RSA_KEY_SIZE = 2048
564 // Password encryption
565 const BCRYPT_SALT_SIZE = 10
567 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
568 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
570 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
572 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
573 DO_NOT_LIST: 'do_not_list',
578 // ---------------------------------------------------------------------------
580 // Express static paths (router)
581 const STATIC_PATHS = {
582 THUMBNAILS: '/static/thumbnails/',
583 WEBSEED: '/static/webseed/',
584 REDUNDANCY: '/static/redundancy/',
585 STREAMING_PLAYLISTS: {
586 HLS: '/static/streaming-playlists/hls'
589 const STATIC_DOWNLOAD_PATHS = {
590 TORRENTS: '/download/torrents/',
591 VIDEOS: '/download/videos/',
592 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
594 const LAZY_STATIC_PATHS = {
595 BANNERS: '/lazy-static/banners/',
596 AVATARS: '/lazy-static/avatars/',
597 PREVIEWS: '/lazy-static/previews/',
598 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
599 TORRENTS: '/lazy-static/torrents/'
603 const STATIC_MAX_AGE = {
609 // Videos thumbnail size
610 const THUMBNAILS_SIZE = {
615 const PREVIEWS_SIZE = {
620 const ACTOR_IMAGES_SIZE = {
627 height: 317 // 6/1 ratio
636 // Sub folders of cache directory
637 const FILES_CACHE = {
639 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
640 MAX_AGE: 1000 * 3600 * 3 // 3 hours
643 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
644 MAX_AGE: 1000 * 3600 * 3 // 3 hours
647 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
648 MAX_AGE: 1000 * 3600 * 3 // 3 hours
656 ACTOR_IMAGE_STATIC: {
661 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
662 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
663 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
665 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
669 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
670 SEGMENT_TIME_SECONDS: 4, // 4 seconds
671 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
672 REPLAY_DIRECTORY: 'replay',
673 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
674 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
684 const MEMOIZE_TTL = {
685 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
686 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
687 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
688 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
691 const MEMOIZE_LENGTH = {
692 INFO_HASH_EXISTS: 200
695 const QUEUE_CONCURRENCY = {
696 ACTOR_PROCESS_IMAGE: 3
705 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
707 const ASSETS_PATH = {
708 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
709 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
712 // ---------------------------------------------------------------------------
714 const CUSTOM_HTML_TAG_COMMENTS = {
715 TITLE: '<!-- title tag -->',
716 DESCRIPTION: '<!-- description tag -->',
717 CUSTOM_CSS: '<!-- custom css tag -->',
718 META_TAGS: '<!-- meta tags -->',
719 SERVER_CONFIG: '<!-- server config -->'
722 // ---------------------------------------------------------------------------
728 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
729 const LOG_FILENAME = 'peertube.log'
730 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
732 // ---------------------------------------------------------------------------
734 const TRACKER_RATE_LIMITS = {
735 INTERVAL: 60000 * 5, // 5 minutes
736 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
737 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
738 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
741 const P2P_MEDIA_LOADER_PEER_VERSION = 2
743 // ---------------------------------------------------------------------------
745 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
746 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
748 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
750 const DEFAULT_THEME_NAME = 'default'
751 const DEFAULT_USER_THEME_NAME = 'instance-default'
753 // ---------------------------------------------------------------------------
755 const SEARCH_INDEX = {
757 VIDEOS: '/api/v1/search/videos',
758 VIDEO_CHANNELS: '/api/v1/search/video-channels'
762 // ---------------------------------------------------------------------------
764 // Special constants for a test instance
765 if (isTestInstance() === true) {
766 PRIVATE_RSA_KEY_SIZE = 1024
768 ACTOR_FOLLOW_SCORE.BASE = 20
770 REMOTE_SCHEME.HTTP = 'http'
771 REMOTE_SCHEME.WS = 'ws'
773 STATIC_MAX_AGE.SERVER = '0'
775 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
776 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
777 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
778 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
780 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
781 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
783 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
784 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
785 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
786 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
787 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
788 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
789 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
790 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
791 REPEAT_JOBS['videos-views'] = { every: 5000 }
792 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
794 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
796 VIEW_LIFETIME.VIDEO = 1000 // 1 second
797 VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
798 CONTACT_FORM_LIFETIME = 1000 // 1 second
800 JOB_ATTEMPTS['email'] = 1
802 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
803 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
804 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
805 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
807 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
809 VIDEO_LIVE.CLEANUP_DELAY = 5000
810 VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
811 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
814 updateWebserverUrls()
815 updateWebserverConfig()
817 registerConfigChangedHandler(() => {
818 updateWebserverUrls()
819 updateWebserverConfig()
822 // ---------------------------------------------------------------------------
824 const FILES_CONTENT_HASH = {
825 MANIFEST: generateContentHash(),
826 FAVICON: generateContentHash(),
827 LOGO: generateContentHash()
830 // ---------------------------------------------------------------------------
839 RESUMABLE_UPLOAD_DIRECTORY,
840 RESUMABLE_UPLOAD_SESSION_LIFETIME,
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,
899 USER_PASSWORD_RESET_LIFETIME,
900 USER_PASSWORD_CREATE_LIFETIME,
902 USER_EMAIL_VERIFY_LIFETIME,
904 SCHEDULER_INTERVALS_MS,
906 STATIC_DOWNLOAD_PATHS,
908 CRAWL_REQUEST_CONCURRENCY,
909 DEFAULT_AUDIO_RESOLUTION,
910 BINARY_CONTENT_TYPES,
911 JOB_COMPLETED_LIFETIME,
915 CONTACT_FORM_LIFETIME,
916 VIDEO_PLAYLIST_PRIVACIES,
917 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
925 // ---------------------------------------------------------------------------
927 function buildVideoMimetypeExt () {
929 // streamable formats that warrant cross-browser compatibility
930 'video/webm': '.webm',
931 // We'll add .ogg if additional extensions are enabled
932 // We could add .ogg here but since it could be an audio file,
933 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
934 'video/ogg': [ '.ogv' ],
938 if (CONFIG.TRANSCODING.ENABLED) {
939 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
940 data['video/ogg'].push('.ogg')
942 Object.assign(data, {
943 'video/x-matroska': '.mkv',
945 // Developed by Apple
946 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
947 'video/x-m4v': '.m4v',
950 // Developed by the Adobe Flash Platform
951 'video/x-flv': '.flv',
952 'video/x-f4v': '.f4v', // replacement for flv
954 // Developed by Microsoft
955 'video/x-ms-wmv': '.wmv',
956 'video/x-msvideo': '.avi',
960 // common video formats for cell phones
961 'video/3gpp': [ '.3gp', '.3gpp' ],
962 'video/3gpp2': [ '.3g2', '.3gpp2' ],
964 // Developed by FFmpeg/Mplayer
965 'application/x-nut': '.nut',
967 // The standard video format used by many Sony and Panasonic HD camcorders.
968 // It is also used for storing high definition video on Blu-ray discs.
969 'video/mp2t': '.mts',
970 'video/m2ts': '.m2ts',
972 // Old formats reliant on MPEG-1/MPEG-2
974 'video/mpeg2': '.m2v',
975 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
979 'application/octet-stream': null,
980 'application/mxf': '.mxf' // often used as exchange format by editing software
984 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
985 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
992 function updateWebserverUrls () {
993 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
994 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
995 WEBSERVER.WS = CONFIG.WEBSERVER.WS
997 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
998 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
999 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
1001 WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1002 WEBSERVER.RTMPS_URL = 'rtmps://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMPS.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')