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,
151 'videos-views-stats': 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,
167 'videos-views-stats': 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-stats': 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 in JobType ]?: EveryRepeatOptions | CronRepeatOptions } = {
191 'videos-views-stats': {
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 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
215 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
216 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
217 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
218 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
219 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
220 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
221 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 * 16 // 16 hours
224 // ---------------------------------------------------------------------------
226 const CONSTRAINTS_FIELDS = {
228 NAME: { min: 1, max: 120 }, // Length
229 DESCRIPTION: { min: 3, max: 1000 }, // Length
230 USERNAME: { min: 1, max: 50 }, // Length
231 PASSWORD: { min: 6, max: 255 }, // Length
232 VIDEO_QUOTA: { min: -1 },
233 VIDEO_QUOTA_DAILY: { min: -1 },
234 VIDEO_LANGUAGES: { max: 500 }, // Array length
235 BLOCKED_REASON: { min: 3, max: 250 } // Length
238 REASON: { min: 2, max: 3000 }, // Length
239 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
242 MESSAGE: { min: 2, max: 3000 } // Length
245 REASON: { min: 2, max: 300 } // Length
248 NAME: { min: 1, max: 120 }, // Length
249 DESCRIPTION: { min: 3, max: 1000 }, // Length
250 SUPPORT: { min: 3, max: 1000 }, // Length
251 URL: { min: 3, max: 2000 } // Length
255 EXTNAME: [ '.vtt', '.srt' ],
257 max: 4 * 1024 * 1024 // 4MB
262 URL: { min: 3, max: 2000 }, // Length
263 TORRENT_NAME: { min: 3, max: 255 }, // Length
265 EXTNAME: [ '.torrent' ],
267 max: 1024 * 200 // 200 KB
272 URL: { min: 3, max: 2000 } // Length
275 URL: { min: 3, max: 2000 } // Length
278 NAME: { min: 3, max: 120 }, // Length
279 LANGUAGE: { min: 1, max: 10 }, // Length
280 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
281 DESCRIPTION: { min: 3, max: 10000 }, // Length
282 SUPPORT: { min: 3, max: 1000 }, // Length
284 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
286 max: 4 * 1024 * 1024 // 4MB
289 EXTNAME: [] as string[],
290 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
291 DURATION: { min: 0 }, // Number
292 TAGS: { min: 0, max: 5 }, // Number of total tags
293 TAG: { min: 2, max: 30 }, // Length
296 DISLIKES: { min: 0 },
297 FILE_SIZE: { min: -1 },
298 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
299 URL: { min: 3, max: 2000 } // Length
302 NAME: { min: 1, max: 120 }, // Length
303 DESCRIPTION: { min: 3, max: 1000 }, // Length
304 URL: { min: 3, max: 2000 }, // Length
306 EXTNAME: [ '.jpg', '.jpeg' ],
308 max: 4 * 1024 * 1024 // 4MB
313 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
314 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
315 URL: { min: 3, max: 2000 }, // Length
317 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
319 max: 4 * 1024 * 1024 // 4MB
327 TEXT: { min: 1, max: 10000 }, // Length
328 URL: { min: 3, max: 2000 } // Length
331 URL: { min: 3, max: 2000 } // Length
334 FROM_NAME: { min: 1, max: 120 }, // Length
335 BODY: { min: 3, max: 5000 } // Length
338 NAME: { min: 1, max: 214 }, // Length
339 DESCRIPTION: { min: 1, max: 20000 } // Length
342 URL: { min: 5, max: 2000 } // Length
346 const VIEW_LIFETIME = {
347 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
348 VIEWER: 60000 * 5 // 5 minutes
351 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
353 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
355 STANDARD: [ 24, 25, 30 ],
356 HD_STANDARD: [ 50, 60 ],
359 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
362 const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
364 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
369 const FFMPEG_NICE: { [ id: string ]: number } = {
370 // parent process defaults to niceness = 0
371 // reminder: lower = higher priority, max value is 19, lowest is -20
372 LIVE: 5, // prioritize over VOD and THUMBNAIL
377 const VIDEO_CATEGORIES = {
388 11: 'News & Politics',
392 15: 'Science & Technology',
398 // See https://creativecommons.org/licenses/?lang=en
399 const VIDEO_LICENCES = {
401 2: 'Attribution - Share Alike',
402 3: 'Attribution - No Derivatives',
403 4: 'Attribution - Non Commercial',
404 5: 'Attribution - Non Commercial - Share Alike',
405 6: 'Attribution - Non Commercial - No Derivatives',
406 7: 'Public Domain Dedication'
409 const VIDEO_LANGUAGES: { [id: string]: string } = {}
411 const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
412 [VideoPrivacy.PUBLIC]: 'Public',
413 [VideoPrivacy.UNLISTED]: 'Unlisted',
414 [VideoPrivacy.PRIVATE]: 'Private',
415 [VideoPrivacy.INTERNAL]: 'Internal'
418 const VIDEO_STATES: { [ id in VideoState ]: string } = {
419 [VideoState.PUBLISHED]: 'Published',
420 [VideoState.TO_TRANSCODE]: 'To transcode',
421 [VideoState.TO_IMPORT]: 'To import',
422 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
423 [VideoState.LIVE_ENDED]: 'Livestream ended',
424 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
425 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed'
428 const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
429 [VideoImportState.FAILED]: 'Failed',
430 [VideoImportState.PENDING]: 'Pending',
431 [VideoImportState.SUCCESS]: 'Success',
432 [VideoImportState.REJECTED]: 'Rejected'
435 const ABUSE_STATES: { [ id in AbuseState ]: string } = {
436 [AbuseState.PENDING]: 'Pending',
437 [AbuseState.REJECTED]: 'Rejected',
438 [AbuseState.ACCEPTED]: 'Accepted'
441 const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
442 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
443 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
444 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
447 const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
448 [VideoPlaylistType.REGULAR]: 'Regular',
449 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
455 'audio/mpeg': '.mp3',
457 'application/ogg': '.ogg',
459 'audio/x-ms-wma': '.wma',
461 'audio/x-wav': '.wav',
462 'audio/x-flac': '.flac',
463 'audio/flac': '.flac',
467 'audio/x-m4a': '.m4a',
470 EXT_MIMETYPE: null as { [ id: string ]: string }
473 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
474 MIMETYPES_REGEX: null as string,
475 EXT_MIMETYPE: null as { [ id: string ]: string }
481 'image/webp': '.webp',
485 EXT_MIMETYPE: null as { [ id: string ]: string }
490 'application/x-subrip': '.srt',
496 'application/x-bittorrent': '.torrent'
500 MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
501 MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
503 const BINARY_CONTENT_TYPES = new Set([
504 'binary/octet-stream',
505 'application/octet-stream',
506 'application/x-binary'
509 // ---------------------------------------------------------------------------
518 // ---------------------------------------------------------------------------
520 const SERVER_ACTOR_NAME = 'peertube'
522 const ACTIVITY_PUB = {
523 POTENTIAL_ACCEPT_HEADERS: [
524 'application/activity+json',
525 'application/ld+json',
526 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
528 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
529 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
530 COLLECTION_ITEMS_PER_PAGE: 10,
531 FETCH_PAGE_LIMIT: 2000,
533 VIDEO: [] as string[],
534 TORRENT: [ 'application/x-bittorrent' ],
535 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
537 MAX_RECURSION_COMMENTS: 100,
538 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
539 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
540 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
543 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
546 APPLICATION: 'Application',
547 ORGANIZATION: 'Organization',
551 const HTTP_SIGNATURE = {
552 HEADER_NAME: 'signature',
553 ALGORITHM: 'rsa-sha256',
554 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
556 ALL: [ '(request-target)', 'host', 'date' ],
557 POST: [ '(request-target)', 'host', 'date', 'digest' ]
559 CLOCK_SKEW_SECONDS: 1800
562 // ---------------------------------------------------------------------------
564 let PRIVATE_RSA_KEY_SIZE = 2048
566 // Password encryption
567 const BCRYPT_SALT_SIZE = 10
569 const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
570 const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
572 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
574 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
575 DO_NOT_LIST: 'do_not_list',
580 // ---------------------------------------------------------------------------
582 // Express static paths (router)
583 const STATIC_PATHS = {
584 THUMBNAILS: '/static/thumbnails/',
585 WEBSEED: '/static/webseed/',
586 REDUNDANCY: '/static/redundancy/',
587 STREAMING_PLAYLISTS: {
588 HLS: '/static/streaming-playlists/hls'
591 const STATIC_DOWNLOAD_PATHS = {
592 TORRENTS: '/download/torrents/',
593 VIDEOS: '/download/videos/',
594 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
596 const LAZY_STATIC_PATHS = {
597 BANNERS: '/lazy-static/banners/',
598 AVATARS: '/lazy-static/avatars/',
599 PREVIEWS: '/lazy-static/previews/',
600 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
601 TORRENTS: '/lazy-static/torrents/'
605 const STATIC_MAX_AGE = {
611 // Videos thumbnail size
612 const THUMBNAILS_SIZE = {
617 const PREVIEWS_SIZE = {
622 const ACTOR_IMAGES_SIZE = {
629 height: 317 // 6/1 ratio
638 // Sub folders of cache directory
639 const FILES_CACHE = {
641 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
642 MAX_AGE: 1000 * 3600 * 3 // 3 hours
645 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
646 MAX_AGE: 1000 * 3600 * 3 // 3 hours
649 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
650 MAX_AGE: 1000 * 3600 * 3 // 3 hours
658 ACTOR_IMAGE_STATIC: {
663 const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads')
664 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
665 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
667 const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
671 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
672 SEGMENT_TIME_SECONDS: 4, // 4 seconds
673 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
674 REPLAY_DIRECTORY: 'replay',
675 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
676 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
686 const MEMOIZE_TTL = {
687 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
688 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
689 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
690 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
693 const MEMOIZE_LENGTH = {
694 INFO_HASH_EXISTS: 200
697 const QUEUE_CONCURRENCY = {
698 ACTOR_PROCESS_IMAGE: 3
707 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
709 const ASSETS_PATH = {
710 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
711 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
714 // ---------------------------------------------------------------------------
716 const CUSTOM_HTML_TAG_COMMENTS = {
717 TITLE: '<!-- title tag -->',
718 DESCRIPTION: '<!-- description tag -->',
719 CUSTOM_CSS: '<!-- custom css tag -->',
720 META_TAGS: '<!-- meta tags -->',
721 SERVER_CONFIG: '<!-- server config -->'
724 // ---------------------------------------------------------------------------
730 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
731 const LOG_FILENAME = 'peertube.log'
732 const AUDIT_LOG_FILENAME = 'peertube-audit.log'
734 // ---------------------------------------------------------------------------
736 const TRACKER_RATE_LIMITS = {
737 INTERVAL: 60000 * 5, // 5 minutes
738 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
739 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
740 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
743 const P2P_MEDIA_LOADER_PEER_VERSION = 2
745 // ---------------------------------------------------------------------------
747 const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
748 const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
750 let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
752 const DEFAULT_THEME_NAME = 'default'
753 const DEFAULT_USER_THEME_NAME = 'instance-default'
755 // ---------------------------------------------------------------------------
757 const SEARCH_INDEX = {
759 VIDEOS: '/api/v1/search/videos',
760 VIDEO_CHANNELS: '/api/v1/search/video-channels'
764 // ---------------------------------------------------------------------------
766 // Special constants for a test instance
767 if (isTestInstance() === true) {
768 PRIVATE_RSA_KEY_SIZE = 1024
770 ACTOR_FOLLOW_SCORE.BASE = 20
772 REMOTE_SCHEME.HTTP = 'http'
773 REMOTE_SCHEME.WS = 'ws'
775 STATIC_MAX_AGE.SERVER = '0'
777 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
778 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
779 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
780 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
782 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
783 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
785 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
786 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
787 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
788 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
789 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
790 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
791 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
792 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
793 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
794 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
796 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
798 VIEW_LIFETIME.VIEWER = 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 RESUMABLE_UPLOAD_SESSION_LIFETIME,
842 HLS_REDUNDANCY_DIRECTORY,
843 P2P_MEDIA_LOADER_PEER_VERSION,
855 AP_CLEANER_CONCURRENCY,
856 LAST_MIGRATION_VERSION,
858 CUSTOM_HTML_TAG_COMMENTS,
859 BROADCAST_CONCURRENCY,
866 DEFAULT_USER_THEME_NAME,
868 PLUGIN_GLOBAL_CSS_FILE_NAME,
869 PLUGIN_GLOBAL_CSS_PATH,
870 PRIVATE_RSA_KEY_SIZE,
871 ROUTE_CACHE_LIFETIME,
873 HLS_STREAMING_PLAYLIST_DIRECTORY,
880 VIDEO_IMPORT_TIMEOUT,
881 VIDEO_PLAYLIST_TYPES,
882 MAX_LOGS_OUTPUT_CHARACTERS,
884 ACTIVITY_PUB_ACTOR_TYPES,
895 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
1003 WEBSERVER.RTMPS_URL = 'rtmps://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1006 function updateWebserverConfig () {
1007 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
1008 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1010 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1012 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1014 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1017 function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1018 const result: { [id: string]: string } = {}
1020 for (const mimetype of Object.keys(obj)) {
1021 const value = obj[mimetype]
1022 if (!value) continue
1024 const extensions = Array.isArray(value) ? value : [ value ]
1026 for (const extension of extensions) {
1027 result[extension] = mimetype
1034 function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1035 return Object.keys(obj)
1040 function loadLanguages () {
1041 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1044 function buildLanguages () {
1045 const iso639 = require('iso-639-3')
1047 const languages: { [id: string]: string } = {}
1049 const additionalLanguages = {
1050 sgn: true, // Sign languages (macro language)
1051 ase: true, // American sign language
1052 sdl: true, // Arabian sign language
1053 bfi: true, // British sign language
1054 bzs: true, // Brazilian sign language
1055 csl: true, // Chinese sign language
1056 cse: true, // Czech sign language
1057 dsl: true, // Danish sign language
1058 fsl: true, // French sign language
1059 gsg: true, // German sign language
1060 pks: true, // Pakistan sign language
1061 jsl: true, // Japanese sign language
1062 sfs: true, // South African sign language
1063 swl: true, // Swedish sign language
1064 rsl: true, // Russian sign language
1066 kab: true, // Kabyle
1070 epo: true, // Esperanto
1071 tlh: true, // Klingon
1072 jbo: true, // Lojban
1076 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1079 return (l.iso6391 !== undefined && l.type === 'living') ||
1080 additionalLanguages[l.iso6393] === true
1082 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1084 // Override Occitan label
1085 languages['oc'] = 'Occitan'
1086 languages['el'] = 'Greek'
1091 function generateContentHash () {
1092 return randomBytes(20).toString('hex')