1 import { randomInt } from '../../shared/core-utils/miscs/miscs'
2 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
3 import { randomBytes } from 'crypto'
4 import { invert } from 'lodash'
5 import { join } from 'path'
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 = 570
29 // ---------------------------------------------------------------------------
31 const API_VERSION = 'v1'
32 const PEERTUBE_VERSION = 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' ],
72 FOLLOWERS: [ 'createdAt', 'state', 'score' ],
73 FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
75 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
77 // Don't forget to update peertube-search-index with the same values
78 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
79 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
81 ABUSES: [ 'id', 'createdAt', 'state' ],
83 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
84 SERVERS_BLOCKLIST: [ 'createdAt' ],
86 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
88 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
90 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
92 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
94 VIDEO_REDUNDANCIES: [ 'name' ]
97 const OAUTH_LIFETIME = {
98 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
99 REFRESH_TOKEN: 1209600 // 2 weeks
102 const ROUTE_CACHE_LIFETIME = {
106 SECURITYTXT: '2 hours',
107 NODEINFO: '10 minutes',
108 DNT_POLICY: '1 week',
110 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
115 // ---------------------------------------------------------------------------
117 // Number of points we add/remove after a successful/bad request
118 const ACTOR_FOLLOW_SCORE = {
125 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
130 const REMOTE_SCHEME = {
135 const JOB_ATTEMPTS: { [id in JobType]: number } = {
136 'activitypub-http-broadcast': 5,
137 'activitypub-http-unicast': 5,
138 'activitypub-http-fetcher': 5,
139 'activitypub-follow': 5,
140 'video-file-import': 1,
141 'video-transcoding': 1,
145 'activitypub-refresher': 1,
146 'video-redundancy': 1,
147 'video-live-ending': 1
149 const JOB_CONCURRENCY: { [id in JobType]?: number } = {
150 'activitypub-http-broadcast': 1,
151 'activitypub-http-unicast': 5,
152 'activitypub-http-fetcher': 1,
153 'activitypub-follow': 1,
154 'video-file-import': 1,
157 'activitypub-refresher': 1,
158 'video-redundancy': 1,
159 'video-live-ending': 10
161 const JOB_TTL: { [id in JobType]: number } = {
162 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
163 'activitypub-http-unicast': 60000 * 10, // 10 minutes
164 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
165 'activitypub-follow': 60000 * 10, // 10 minutes
166 'video-file-import': 1000 * 3600, // 1 hour
167 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
168 'video-import': 1000 * 3600 * 2, // 2 hours
169 'email': 60000 * 10, // 10 minutes
170 'videos-views': undefined, // Unlimited
171 'activitypub-refresher': 60000 * 10, // 10 minutes
172 'video-redundancy': 1000 * 3600 * 3, // 3 hours
173 'video-live-ending': 1000 * 60 * 10 // 10 minutes
175 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
177 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
180 const JOB_PRIORITY = {
187 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
188 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
189 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
190 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
191 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
193 const SCHEDULER_INTERVALS_MS = {
194 actorFollowScores: 60000 * 60, // 1 hour
195 removeOldJobs: 60000 * 60, // 1 hour
196 updateVideos: 60000, // 1 minute
197 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
198 checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
199 autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
200 removeOldViews: 60000 * 60 * 24, // 1 day
201 removeOldHistory: 60000 * 60 * 24, // 1 day
202 updateInboxStats: 1000 * 60// 1 minute
205 // ---------------------------------------------------------------------------
207 const CONSTRAINTS_FIELDS = {
209 NAME: { min: 1, max: 120 }, // Length
210 DESCRIPTION: { min: 3, max: 1000 }, // Length
211 USERNAME: { min: 1, max: 50 }, // Length
212 PASSWORD: { min: 6, max: 255 }, // Length
213 VIDEO_QUOTA: { min: -1 },
214 VIDEO_QUOTA_DAILY: { min: -1 },
215 VIDEO_LANGUAGES: { max: 500 }, // Array length
216 BLOCKED_REASON: { min: 3, max: 250 } // Length
219 REASON: { min: 2, max: 3000 }, // Length
220 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
223 MESSAGE: { min: 2, max: 3000 } // Length
226 REASON: { min: 2, max: 300 } // Length
229 NAME: { min: 1, max: 120 }, // Length
230 DESCRIPTION: { min: 3, max: 1000 }, // Length
231 SUPPORT: { min: 3, max: 1000 }, // Length
232 URL: { min: 3, max: 2000 } // Length
236 EXTNAME: [ '.vtt', '.srt' ],
238 max: 2 * 1024 * 1024 // 2MB
243 URL: { min: 3, max: 2000 }, // Length
244 TORRENT_NAME: { min: 3, max: 255 }, // Length
246 EXTNAME: [ '.torrent' ],
248 max: 1024 * 200 // 200 KB
253 URL: { min: 3, max: 2000 } // Length
256 URL: { min: 3, max: 2000 } // Length
259 NAME: { min: 3, max: 120 }, // Length
260 LANGUAGE: { min: 1, max: 10 }, // Length
261 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
262 DESCRIPTION: { min: 3, max: 10000 }, // Length
263 SUPPORT: { min: 3, max: 1000 }, // Length
265 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
267 max: 2 * 1024 * 1024 // 2MB
270 EXTNAME: [] as string[],
271 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
272 DURATION: { min: 0 }, // Number
273 TAGS: { min: 0, max: 5 }, // Number of total tags
274 TAG: { min: 2, max: 30 }, // Length
277 DISLIKES: { min: 0 },
278 FILE_SIZE: { min: -1 },
279 URL: { min: 3, max: 2000 } // Length
282 NAME: { min: 1, max: 120 }, // Length
283 DESCRIPTION: { min: 3, max: 1000 }, // Length
284 URL: { min: 3, max: 2000 }, // Length
286 EXTNAME: [ '.jpg', '.jpeg' ],
288 max: 2 * 1024 * 1024 // 2MB
293 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
294 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
295 URL: { min: 3, max: 2000 }, // Length
297 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
299 max: 2 * 1024 * 1024 // 2MB
307 TEXT: { min: 1, max: 10000 }, // Length
308 URL: { min: 3, max: 2000 } // Length
311 URL: { min: 3, max: 2000 } // Length
314 FROM_NAME: { min: 1, max: 120 }, // Length
315 BODY: { min: 3, max: 5000 } // Length
318 NAME: { min: 1, max: 214 }, // Length
319 DESCRIPTION: { min: 1, max: 20000 } // Length
322 URL: { min: 5, max: 2000 } // Length
326 const VIEW_LIFETIME = {
327 VIDEO: 60000 * 60, // 1 hour
328 LIVE: 60000 * 5 // 5 minutes
331 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
333 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
335 STANDARD: [ 24, 25, 30 ],
336 HD_STANDARD: [ 50, 60 ],
339 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
342 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
344 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
349 const FFMPEG_NICE: { [ id: string ]: number } = {
350 // parent process defaults to niceness = 0
351 // reminder: lower = higher priority, max value is 19, lowest is -20
352 LIVE: 5, // prioritize over VOD and THUMBNAIL
357 const VIDEO_CATEGORIES = {
368 11: 'News & Politics',
372 15: 'Science & Technology',
378 // See https://creativecommons.org/licenses/?lang=en
379 const VIDEO_LICENCES = {
381 2: 'Attribution - Share Alike',
382 3: 'Attribution - No Derivatives',
383 4: 'Attribution - Non Commercial',
384 5: 'Attribution - Non Commercial - Share Alike',
385 6: 'Attribution - Non Commercial - No Derivatives',
386 7: 'Public Domain Dedication'
389 const VIDEO_LANGUAGES: { [id: string]: string } = {}
391 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
392 [VideoPrivacy.PUBLIC]: 'Public',
393 [VideoPrivacy.UNLISTED]: 'Unlisted',
394 [VideoPrivacy.PRIVATE]: 'Private',
395 [VideoPrivacy.INTERNAL]: 'Internal'
398 const VIDEO_STATES: { [ id in VideoState ]: string } = {
399 [VideoState.PUBLISHED]: 'Published',
400 [VideoState.TO_TRANSCODE]: 'To transcode',
401 [VideoState.TO_IMPORT]: 'To import',
402 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
403 [VideoState.LIVE_ENDED]: 'Livestream ended'
406 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
407 [VideoImportState.FAILED]: 'Failed',
408 [VideoImportState.PENDING]: 'Pending',
409 [VideoImportState.SUCCESS]: 'Success',
410 [VideoImportState.REJECTED]: 'Rejected'
413 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
414 [AbuseState.PENDING]: 'Pending',
415 [AbuseState.REJECTED]: 'Rejected',
416 [AbuseState.ACCEPTED]: 'Accepted'
419 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
420 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
421 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
422 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
425 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
426 [VideoPlaylistType.REGULAR]: 'Regular',
427 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
433 'audio/mpeg': '.mp3',
435 'application/ogg': '.ogg',
437 'audio/x-ms-wma': '.wma',
439 'audio/x-flac': '.flac',
440 'audio/flac': '.flac',
441 '‎audio/aac': '.aac',
444 EXT_MIMETYPE: null as { [ id: string ]: string }
447 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
448 MIMETYPES_REGEX: null as string,
449 EXT_MIMETYPE: null as { [ id: string ]: string }
457 EXT_MIMETYPE: null as { [ id: string ]: string }
462 'application/x-subrip': '.srt',
468 'application/x-bittorrent': '.torrent'
472 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
473 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
475 // ---------------------------------------------------------------------------
484 const VIDEO_CHANNELS = {
488 // ---------------------------------------------------------------------------
490 const SERVER_ACTOR_NAME = 'peertube'
492 const ACTIVITY_PUB = {
493 POTENTIAL_ACCEPT_HEADERS: [
494 'application/activity+json',
495 'application/ld+json',
496 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
498 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
499 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
500 COLLECTION_ITEMS_PER_PAGE: 10,
501 FETCH_PAGE_LIMIT: 2000,
503 VIDEO: [] as string[],
504 TORRENT: [ 'application/x-bittorrent' ],
505 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
507 MAX_RECURSION_COMMENTS: 100,
508 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
509 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
510 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
513 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
516 APPLICATION: 'Application',
517 ORGANIZATION: 'Organization',
521 const HTTP_SIGNATURE = {
522 HEADER_NAME: 'signature',
523 ALGORITHM: 'rsa-sha256',
524 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
526 ALL: [ '(request-target)', 'host', 'date' ],
527 POST: [ '(request-target)', 'host', 'date', 'digest' ]
529 CLOCK_SKEW_SECONDS: 1800
532 // ---------------------------------------------------------------------------
534 let PRIVATE_RSA_KEY_SIZE = 2048
536 // Password encryption
537 const BCRYPT_SALT_SIZE = 10
539 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
540 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
542 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
544 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
545 DO_NOT_LIST: 'do_not_list',
550 // ---------------------------------------------------------------------------
552 // Express static paths (router)
553 const STATIC_PATHS = {
554 PREVIEWS: '/static/previews/',
555 THUMBNAILS: '/static/thumbnails/',
556 TORRENTS: '/static/torrents/',
557 WEBSEED: '/static/webseed/',
558 REDUNDANCY: '/static/redundancy/',
559 STREAMING_PLAYLISTS: {
560 HLS: '/static/streaming-playlists/hls'
562 AVATARS: '/static/avatars/',
563 VIDEO_CAPTIONS: '/static/video-captions/'
565 const STATIC_DOWNLOAD_PATHS = {
566 TORRENTS: '/download/torrents/',
567 VIDEOS: '/download/videos/',
568 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
570 const LAZY_STATIC_PATHS = {
571 AVATARS: '/lazy-static/avatars/',
572 PREVIEWS: '/lazy-static/previews/',
573 VIDEO_CAPTIONS: '/lazy-static/video-captions/'
577 const STATIC_MAX_AGE = {
582 // Videos thumbnail size
583 const THUMBNAILS_SIZE = {
588 const PREVIEWS_SIZE = {
593 const AVATARS_SIZE = {
603 // Sub folders of cache directory
604 const FILES_CACHE = {
606 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
607 MAX_AGE: 1000 * 3600 * 3 // 3 hours
610 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
611 MAX_AGE: 1000 * 3600 * 3 // 3 hours
624 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
625 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
629 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
630 SEGMENT_TIME_SECONDS: 4, // 4 seconds
631 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
632 REPLAY_DIRECTORY: 'replay',
633 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
634 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
644 const MEMOIZE_TTL = {
645 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
646 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
647 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
648 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
651 const MEMOIZE_LENGTH = {
652 INFO_HASH_EXISTS: 200
655 const QUEUE_CONCURRENCY = {
656 AVATAR_PROCESS_IMAGE: 3
665 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
667 const ASSETS_PATH = {
668 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
669 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
672 // ---------------------------------------------------------------------------
674 const CUSTOM_HTML_TAG_COMMENTS = {
675 TITLE: '<!-- title tag -->',
676 DESCRIPTION: '<!-- description tag -->',
677 CUSTOM_CSS: '<!-- custom css tag -->',
678 META_TAGS: '<!-- meta tags -->'
681 // ---------------------------------------------------------------------------
687 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
688 const LOG_FILENAME = 'peertube.log'
689 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
691 // ---------------------------------------------------------------------------
693 const TRACKER_RATE_LIMITS = {
694 INTERVAL: 60000 * 5, // 5 minutes
695 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
696 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
697 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
700 const P2P_MEDIA_LOADER_PEER_VERSION = 2
702 // ---------------------------------------------------------------------------
704 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
705 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
707 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
709 const DEFAULT_THEME_NAME = 'default'
710 const DEFAULT_USER_THEME_NAME = 'instance-default'
712 // ---------------------------------------------------------------------------
714 const SEARCH_INDEX = {
716 VIDEOS: '/api/v1/search/videos',
717 VIDEO_CHANNELS: '/api/v1/search/video-channels'
721 // ---------------------------------------------------------------------------
723 // Special constants for a test instance
724 if (isTestInstance() === true) {
725 PRIVATE_RSA_KEY_SIZE = 1024
727 ACTOR_FOLLOW_SCORE.BASE = 20
729 REMOTE_SCHEME.HTTP = 'http'
730 REMOTE_SCHEME.WS = 'ws'
732 STATIC_MAX_AGE.SERVER = '0'
734 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
735 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
736 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
737 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
739 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
740 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
742 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
743 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
744 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
745 SCHEDULER_INTERVALS_MS.removeOldViews = 5000
746 SCHEDULER_INTERVALS_MS.updateVideos = 5000
747 SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
748 SCHEDULER_INTERVALS_MS.updateInboxStats = 5000
749 REPEAT_JOBS['videos-views'] = { every: 5000 }
751 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
753 VIEW_LIFETIME.VIDEO = 1000 // 1 second
754 VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
755 CONTACT_FORM_LIFETIME = 1000 // 1 second
757 JOB_ATTEMPTS['email'] = 1
759 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
760 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
761 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
762 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
764 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
766 VIDEO_LIVE.CLEANUP_DELAY = 5000
767 VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
768 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
771 updateWebserverUrls()
772 updateWebserverConfig()
774 registerConfigChangedHandler(() => {
775 updateWebserverUrls()
776 updateWebserverConfig()
779 // ---------------------------------------------------------------------------
781 const FILES_CONTENT_HASH = {
782 MANIFEST: generateContentHash(),
783 FAVICON: generateContentHash(),
784 LOGO: generateContentHash()
787 // ---------------------------------------------------------------------------
796 HLS_REDUNDANCY_DIRECTORY,
797 P2P_MEDIA_LOADER_PEER_VERSION,
809 LAST_MIGRATION_VERSION,
811 CUSTOM_HTML_TAG_COMMENTS,
812 BROADCAST_CONCURRENCY,
819 DEFAULT_USER_THEME_NAME,
821 PLUGIN_GLOBAL_CSS_FILE_NAME,
822 PLUGIN_GLOBAL_CSS_PATH,
823 PRIVATE_RSA_KEY_SIZE,
824 ROUTE_CACHE_LIFETIME,
826 HLS_STREAMING_PLAYLIST_DIRECTORY,
833 VIDEO_IMPORT_TIMEOUT,
834 VIDEO_PLAYLIST_TYPES,
835 MAX_LOGS_OUTPUT_CHARACTERS,
837 ACTIVITY_PUB_ACTOR_TYPES,
848 VIDEO_TRANSCODING_FPS,
854 USER_PASSWORD_RESET_LIFETIME,
855 USER_PASSWORD_CREATE_LIFETIME,
857 USER_EMAIL_VERIFY_LIFETIME,
859 SCHEDULER_INTERVALS_MS,
861 STATIC_DOWNLOAD_PATHS,
863 CRAWL_REQUEST_CONCURRENCY,
864 DEFAULT_AUDIO_RESOLUTION,
865 JOB_COMPLETED_LIFETIME,
869 CONTACT_FORM_LIFETIME,
870 VIDEO_PLAYLIST_PRIVACIES,
871 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
879 // ---------------------------------------------------------------------------
881 function buildVideoMimetypeExt () {
883 // streamable formats that warrant cross-browser compatibility
884 'video/webm': '.webm',
885 // We'll add .ogg if additional extensions are enabled
886 // We could add .ogg here but since it could be an audio file,
887 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
888 'video/ogg': [ '.ogv' ],
892 if (CONFIG.TRANSCODING.ENABLED) {
893 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
894 data['video/ogg'].push('.ogg')
896 Object.assign(data, {
897 'video/x-matroska': '.mkv',
899 // Developed by Apple
900 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
901 'video/x-m4v': '.m4v',
904 // Developed by the Adobe Flash Platform
905 'video/x-flv': '.flv',
906 'video/x-f4v': '.f4v', // replacement for flv
908 // Developed by Microsoft
909 'video/x-ms-wmv': '.wmv',
910 'video/x-msvideo': '.avi',
914 // common video formats for cell phones
915 'video/3gpp': [ '.3gp', '.3gpp' ],
916 'video/3gpp2': [ '.3g2', '.3gpp2' ],
918 // Developed by FFmpeg/Mplayer
919 'application/x-nut': '.nut',
921 // The standard video format used by many Sony and Panasonic HD camcorders.
922 // It is also used for storing high definition video on Blu-ray discs.
923 'video/mp2t': '.mts',
924 'video/m2ts': '.m2ts',
926 // Old formats reliant on MPEG-1/MPEG-2
928 'video/mpeg2': '.m2v',
929 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
933 'application/octet-stream': null,
934 'application/mxf': '.mxf' // often used as exchange format by editing software
938 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
939 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
946 function updateWebserverUrls () {
947 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
948 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
949 WEBSERVER.WS = CONFIG.WEBSERVER.WS
951 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
952 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
953 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
955 WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
958 function updateWebserverConfig () {
959 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
960 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
962 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
964 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
966 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
969 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
970 const result: { [id: string]: string } = {}
972 for (const mimetype of Object.keys(obj)) {
973 const value = obj[mimetype]
976 const extensions = Array.isArray(value) ? value : [ value ]
978 for (const extension of extensions) {
979 result[extension] = mimetype
986 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
987 return Object.keys(obj)
992 function loadLanguages () {
993 Object.assign(VIDEO_LANGUAGES, buildLanguages())
996 function buildLanguages () {
997 const iso639 = require('iso-639-3')
999 const languages: { [id: string]: string } = {}
1001 const additionalLanguages = {
1002 sgn: true, // Sign languages (macro language)
1003 ase: true, // American sign language
1004 sdl: true, // Arabian sign language
1005 bfi: true, // British sign language
1006 bzs: true, // Brazilian sign language
1007 csl: true, // Chinese sign language
1008 cse: true, // Czech sign language
1009 dsl: true, // Danish sign language
1010 fsl: true, // French sign language
1011 gsg: true, // German sign language
1012 pks: true, // Pakistan sign language
1013 jsl: true, // Japanese sign language
1014 sfs: true, // South African sign language
1015 swl: true, // Swedish sign language
1016 rsl: true, // Russian sign language
1018 kab: true, // Kabyle
1020 epo: true, // Esperanto
1021 tlh: true, // Klingon
1022 jbo: true, // Lojban
1026 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1029 return (l.iso6391 !== undefined && l.type === 'living') ||
1030 additionalLanguages[l.iso6393] === true
1032 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1034 // Override Occitan label
1035 languages['oc'] = 'Occitan'
1036 languages['el'] = 'Greek'
1041 function generateContentHash () {
1042 return randomBytes(20).toString('hex')