]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame_incremental - server/initializers/constants.ts
Add missing niceness to ffmpeg thumbnail processes
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
... / ...
CommitLineData
1import { randomInt } from '../../shared/core-utils/miscs/miscs'
2import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
3import { randomBytes } from 'crypto'
4import { invert } from 'lodash'
5import { join } from 'path'
6import {
7 AbuseState,
8 JobType,
9 VideoImportState,
10 VideoPrivacy,
11 VideoRateType,
12 VideoResolution,
13 VideoState,
14 VideoTranscodingFPS
15} from '../../shared/models'
16import { ActivityPubActorType } from '../../shared/models/activitypub'
17import { FollowState } from '../../shared/models/actors'
18import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
19import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
20import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
21// Do not use barrels, remain constants as independent as possible
22import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
23import { CONFIG, registerConfigChangedHandler } from './config'
24
25// ---------------------------------------------------------------------------
26
27const LAST_MIGRATION_VERSION = 570
28
29// ---------------------------------------------------------------------------
30
31const API_VERSION = 'v1'
32const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
33
34const PAGINATION = {
35 GLOBAL: {
36 COUNT: {
37 DEFAULT: 15,
38 MAX: 100
39 }
40 },
41 OUTBOX: {
42 COUNT: {
43 MAX: 50
44 }
45 }
46}
47
48const WEBSERVER = {
49 URL: '',
50 HOST: '',
51 SCHEME: '',
52 WS: '',
53 HOSTNAME: '',
54 PORT: 0,
55 RTMP_URL: ''
56}
57
58// Sortable columns per schema
59const 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' ],
66
67 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
68 VIDEO_COMMENTS: [ 'createdAt' ],
69
70 VIDEO_RATES: [ 'createdAt' ],
71 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
72 FOLLOWERS: [ 'createdAt', 'state', 'score' ],
73 FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
74
75 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending' ],
76
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' ],
80
81 ABUSES: [ 'id', 'createdAt', 'state' ],
82
83 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
84 SERVERS_BLOCKLIST: [ 'createdAt' ],
85
86 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
87
88 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
89
90 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
91
92 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
93
94 VIDEO_REDUNDANCIES: [ 'name' ]
95}
96
97const OAUTH_LIFETIME = {
98 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
99 REFRESH_TOKEN: 1209600 // 2 weeks
100}
101
102const ROUTE_CACHE_LIFETIME = {
103 FEEDS: '15 minutes',
104 ROBOTS: '2 hours',
105 SITEMAP: '1 day',
106 SECURITYTXT: '2 hours',
107 NODEINFO: '10 minutes',
108 DNT_POLICY: '1 week',
109 ACTIVITY_PUB: {
110 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
111 },
112 STATS: '4 hours'
113}
114
115// ---------------------------------------------------------------------------
116
117// Number of points we add/remove after a successful/bad request
118const ACTOR_FOLLOW_SCORE = {
119 PENALTY: -10,
120 BONUS: 10,
121 BASE: 1000,
122 MAX: 10000
123}
124
125const FOLLOW_STATES: { [ id: string ]: FollowState } = {
126 PENDING: 'pending',
127 ACCEPTED: 'accepted'
128}
129
130const REMOTE_SCHEME = {
131 HTTP: 'https',
132 WS: 'wss'
133}
134
135const 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,
142 'video-import': 1,
143 'email': 5,
144 'videos-views': 1,
145 'activitypub-refresher': 1,
146 'video-redundancy': 1,
147 'video-live-ending': 1
148}
149const 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,
155 'video-transcoding': 1,
156 'video-import': 1,
157 'email': 5,
158 'videos-views': 1,
159 'activitypub-refresher': 1,
160 'video-redundancy': 1,
161 'video-live-ending': 10
162}
163const JOB_TTL: { [id in JobType]: number } = {
164 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
165 'activitypub-http-unicast': 60000 * 10, // 10 minutes
166 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
167 'activitypub-follow': 60000 * 10, // 10 minutes
168 'video-file-import': 1000 * 3600, // 1 hour
169 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
170 'video-import': 1000 * 3600 * 2, // 2 hours
171 'email': 60000 * 10, // 10 minutes
172 'videos-views': undefined, // Unlimited
173 'activitypub-refresher': 60000 * 10, // 10 minutes
174 'video-redundancy': 1000 * 3600 * 3, // 3 hours
175 'video-live-ending': 1000 * 60 * 10 // 10 minutes
176}
177const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
178 'videos-views': {
179 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
180 }
181}
182const JOB_PRIORITY = {
183 TRANSCODING: {
184 OPTIMIZER: 10,
185 NEW_RESOLUTION: 100
186 }
187}
188
189const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
190const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
191const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
192const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
193const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
194
195const SCHEDULER_INTERVALS_MS = {
196 actorFollowScores: 60000 * 60, // 1 hour
197 removeOldJobs: 60000 * 60, // 1 hour
198 updateVideos: 60000, // 1 minute
199 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
200 checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
201 autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
202 removeOldViews: 60000 * 60 * 24, // 1 day
203 removeOldHistory: 60000 * 60 * 24, // 1 day
204 updateInboxStats: 1000 * 60// 1 minute
205}
206
207// ---------------------------------------------------------------------------
208
209const CONSTRAINTS_FIELDS = {
210 USERS: {
211 NAME: { min: 1, max: 120 }, // Length
212 DESCRIPTION: { min: 3, max: 1000 }, // Length
213 USERNAME: { min: 1, max: 50 }, // Length
214 PASSWORD: { min: 6, max: 255 }, // Length
215 VIDEO_QUOTA: { min: -1 },
216 VIDEO_QUOTA_DAILY: { min: -1 },
217 VIDEO_LANGUAGES: { max: 500 }, // Array length
218 BLOCKED_REASON: { min: 3, max: 250 } // Length
219 },
220 ABUSES: {
221 REASON: { min: 2, max: 3000 }, // Length
222 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
223 },
224 ABUSE_MESSAGES: {
225 MESSAGE: { min: 2, max: 3000 } // Length
226 },
227 VIDEO_BLACKLIST: {
228 REASON: { min: 2, max: 300 } // Length
229 },
230 VIDEO_CHANNELS: {
231 NAME: { min: 1, max: 120 }, // Length
232 DESCRIPTION: { min: 3, max: 1000 }, // Length
233 SUPPORT: { min: 3, max: 1000 }, // Length
234 URL: { min: 3, max: 2000 } // Length
235 },
236 VIDEO_CAPTIONS: {
237 CAPTION_FILE: {
238 EXTNAME: [ '.vtt', '.srt' ],
239 FILE_SIZE: {
240 max: 2 * 1024 * 1024 // 2MB
241 }
242 }
243 },
244 VIDEO_IMPORTS: {
245 URL: { min: 3, max: 2000 }, // Length
246 TORRENT_NAME: { min: 3, max: 255 }, // Length
247 TORRENT_FILE: {
248 EXTNAME: [ '.torrent' ],
249 FILE_SIZE: {
250 max: 1024 * 200 // 200 KB
251 }
252 }
253 },
254 VIDEOS_REDUNDANCY: {
255 URL: { min: 3, max: 2000 } // Length
256 },
257 VIDEO_RATES: {
258 URL: { min: 3, max: 2000 } // Length
259 },
260 VIDEOS: {
261 NAME: { min: 3, max: 120 }, // Length
262 LANGUAGE: { min: 1, max: 10 }, // Length
263 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
264 DESCRIPTION: { min: 3, max: 10000 }, // Length
265 SUPPORT: { min: 3, max: 1000 }, // Length
266 IMAGE: {
267 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
268 FILE_SIZE: {
269 max: 2 * 1024 * 1024 // 2MB
270 }
271 },
272 EXTNAME: [] as string[],
273 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
274 DURATION: { min: 0 }, // Number
275 TAGS: { min: 0, max: 5 }, // Number of total tags
276 TAG: { min: 2, max: 30 }, // Length
277 VIEWS: { min: 0 },
278 LIKES: { min: 0 },
279 DISLIKES: { min: 0 },
280 FILE_SIZE: { min: -1 },
281 URL: { min: 3, max: 2000 } // Length
282 },
283 VIDEO_PLAYLISTS: {
284 NAME: { min: 1, max: 120 }, // Length
285 DESCRIPTION: { min: 3, max: 1000 }, // Length
286 URL: { min: 3, max: 2000 }, // Length
287 IMAGE: {
288 EXTNAME: [ '.jpg', '.jpeg' ],
289 FILE_SIZE: {
290 max: 2 * 1024 * 1024 // 2MB
291 }
292 }
293 },
294 ACTORS: {
295 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
296 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
297 URL: { min: 3, max: 2000 }, // Length
298 AVATAR: {
299 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
300 FILE_SIZE: {
301 max: 2 * 1024 * 1024 // 2MB
302 }
303 }
304 },
305 VIDEO_EVENTS: {
306 COUNT: { min: 0 }
307 },
308 VIDEO_COMMENTS: {
309 TEXT: { min: 1, max: 10000 }, // Length
310 URL: { min: 3, max: 2000 } // Length
311 },
312 VIDEO_SHARE: {
313 URL: { min: 3, max: 2000 } // Length
314 },
315 CONTACT_FORM: {
316 FROM_NAME: { min: 1, max: 120 }, // Length
317 BODY: { min: 3, max: 5000 } // Length
318 },
319 PLUGINS: {
320 NAME: { min: 1, max: 214 }, // Length
321 DESCRIPTION: { min: 1, max: 20000 } // Length
322 },
323 COMMONS: {
324 URL: { min: 5, max: 2000 } // Length
325 }
326}
327
328const VIEW_LIFETIME = {
329 VIDEO: 60000 * 60, // 1 hour
330 LIVE: 60000 * 5 // 5 minutes
331}
332
333let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
334
335const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
336 MIN: 10,
337 STANDARD: [ 24, 25, 30 ],
338 HD_STANDARD: [ 50, 60 ],
339 AVERAGE: 30,
340 MAX: 60,
341 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
342}
343
344const VIDEO_TRANSCODING_ENCODERS = {
345 VIDEO: [ 'libx264' ],
346
347 // Try the first one, if not available try the second one etc
348 AUDIO: [
349 // we favor VBR, if a good AAC encoder is available
350 'libfdk_aac',
351 'aac'
352 ]
353}
354
355const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
356
357const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
358 LIKE: 'like',
359 DISLIKE: 'dislike'
360}
361
362const FFMPEG_NICE: { [ id: string ]: number } = {
363 // parent process defaults to niceness = 0
364 // reminder: lower = higher priority, max value is 19, lowest is -20
365 LIVE: 5, // prioritize over VOD and THUMBNAIL
366 THUMBNAIL: 10,
367 VOD: 15
368}
369
370const VIDEO_CATEGORIES = {
371 1: 'Music',
372 2: 'Films',
373 3: 'Vehicles',
374 4: 'Art',
375 5: 'Sports',
376 6: 'Travels',
377 7: 'Gaming',
378 8: 'People',
379 9: 'Comedy',
380 10: 'Entertainment',
381 11: 'News & Politics',
382 12: 'How To',
383 13: 'Education',
384 14: 'Activism',
385 15: 'Science & Technology',
386 16: 'Animals',
387 17: 'Kids',
388 18: 'Food'
389}
390
391// See https://creativecommons.org/licenses/?lang=en
392const VIDEO_LICENCES = {
393 1: 'Attribution',
394 2: 'Attribution - Share Alike',
395 3: 'Attribution - No Derivatives',
396 4: 'Attribution - Non Commercial',
397 5: 'Attribution - Non Commercial - Share Alike',
398 6: 'Attribution - Non Commercial - No Derivatives',
399 7: 'Public Domain Dedication'
400}
401
402const VIDEO_LANGUAGES: { [id: string]: string } = {}
403
404const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
405 [VideoPrivacy.PUBLIC]: 'Public',
406 [VideoPrivacy.UNLISTED]: 'Unlisted',
407 [VideoPrivacy.PRIVATE]: 'Private',
408 [VideoPrivacy.INTERNAL]: 'Internal'
409}
410
411const VIDEO_STATES: { [ id in VideoState ]: string } = {
412 [VideoState.PUBLISHED]: 'Published',
413 [VideoState.TO_TRANSCODE]: 'To transcode',
414 [VideoState.TO_IMPORT]: 'To import',
415 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
416 [VideoState.LIVE_ENDED]: 'Livestream ended'
417}
418
419const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
420 [VideoImportState.FAILED]: 'Failed',
421 [VideoImportState.PENDING]: 'Pending',
422 [VideoImportState.SUCCESS]: 'Success',
423 [VideoImportState.REJECTED]: 'Rejected'
424}
425
426const ABUSE_STATES: { [ id in AbuseState ]: string } = {
427 [AbuseState.PENDING]: 'Pending',
428 [AbuseState.REJECTED]: 'Rejected',
429 [AbuseState.ACCEPTED]: 'Accepted'
430}
431
432const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
433 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
434 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
435 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
436}
437
438const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
439 [VideoPlaylistType.REGULAR]: 'Regular',
440 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
441}
442
443const MIMETYPES = {
444 AUDIO: {
445 MIMETYPE_EXT: {
446 'audio/mpeg': '.mp3',
447 'audio/mp3': '.mp3',
448 'application/ogg': '.ogg',
449 'audio/ogg': '.ogg',
450 'audio/x-ms-wma': '.wma',
451 'audio/wav': '.wav',
452 'audio/x-flac': '.flac',
453 'audio/flac': '.flac',
454 '‎audio/aac': '.aac',
455 'audio/ac3': '.ac3'
456 },
457 EXT_MIMETYPE: null as { [ id: string ]: string }
458 },
459 VIDEO: {
460 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
461 MIMETYPES_REGEX: null as string,
462 EXT_MIMETYPE: null as { [ id: string ]: string }
463 },
464 IMAGE: {
465 MIMETYPE_EXT: {
466 'image/png': '.png',
467 'image/jpg': '.jpg',
468 'image/jpeg': '.jpg'
469 },
470 EXT_MIMETYPE: null as { [ id: string ]: string }
471 },
472 VIDEO_CAPTIONS: {
473 MIMETYPE_EXT: {
474 'text/vtt': '.vtt',
475 'application/x-subrip': '.srt',
476 'text/plain': '.srt'
477 }
478 },
479 TORRENT: {
480 MIMETYPE_EXT: {
481 'application/x-bittorrent': '.torrent'
482 }
483 }
484}
485MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
486MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
487
488// ---------------------------------------------------------------------------
489
490const OVERVIEWS = {
491 VIDEOS: {
492 SAMPLE_THRESHOLD: 6,
493 SAMPLES_COUNT: 20
494 }
495}
496
497const VIDEO_CHANNELS = {
498 MAX_PER_USER: 20
499}
500
501// ---------------------------------------------------------------------------
502
503const SERVER_ACTOR_NAME = 'peertube'
504
505const ACTIVITY_PUB = {
506 POTENTIAL_ACCEPT_HEADERS: [
507 'application/activity+json',
508 'application/ld+json',
509 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
510 ],
511 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
512 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
513 COLLECTION_ITEMS_PER_PAGE: 10,
514 FETCH_PAGE_LIMIT: 2000,
515 URL_MIME_TYPES: {
516 VIDEO: [] as string[],
517 TORRENT: [ 'application/x-bittorrent' ],
518 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
519 },
520 MAX_RECURSION_COMMENTS: 100,
521 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
522 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
523 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
524}
525
526const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
527 GROUP: 'Group',
528 PERSON: 'Person',
529 APPLICATION: 'Application',
530 ORGANIZATION: 'Organization',
531 SERVICE: 'Service'
532}
533
534const HTTP_SIGNATURE = {
535 HEADER_NAME: 'signature',
536 ALGORITHM: 'rsa-sha256',
537 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
538 REQUIRED_HEADERS: {
539 ALL: [ '(request-target)', 'host', 'date' ],
540 POST: [ '(request-target)', 'host', 'date', 'digest' ]
541 },
542 CLOCK_SKEW_SECONDS: 1800
543}
544
545// ---------------------------------------------------------------------------
546
547let PRIVATE_RSA_KEY_SIZE = 2048
548
549// Password encryption
550const BCRYPT_SALT_SIZE = 10
551
552const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
553const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
554
555const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
556
557const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
558 DO_NOT_LIST: 'do_not_list',
559 BLUR: 'blur',
560 DISPLAY: 'display'
561}
562
563// ---------------------------------------------------------------------------
564
565// Express static paths (router)
566const STATIC_PATHS = {
567 PREVIEWS: '/static/previews/',
568 THUMBNAILS: '/static/thumbnails/',
569 TORRENTS: '/static/torrents/',
570 WEBSEED: '/static/webseed/',
571 REDUNDANCY: '/static/redundancy/',
572 STREAMING_PLAYLISTS: {
573 HLS: '/static/streaming-playlists/hls'
574 },
575 AVATARS: '/static/avatars/',
576 VIDEO_CAPTIONS: '/static/video-captions/'
577}
578const STATIC_DOWNLOAD_PATHS = {
579 TORRENTS: '/download/torrents/',
580 VIDEOS: '/download/videos/',
581 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
582}
583const LAZY_STATIC_PATHS = {
584 AVATARS: '/lazy-static/avatars/',
585 PREVIEWS: '/lazy-static/previews/',
586 VIDEO_CAPTIONS: '/lazy-static/video-captions/'
587}
588
589// Cache control
590const STATIC_MAX_AGE = {
591 SERVER: '2h',
592 CLIENT: '30d'
593}
594
595// Videos thumbnail size
596const THUMBNAILS_SIZE = {
597 width: 223,
598 height: 122,
599 minWidth: 150
600}
601const PREVIEWS_SIZE = {
602 width: 850,
603 height: 480,
604 minWidth: 400
605}
606const AVATARS_SIZE = {
607 width: 120,
608 height: 120
609}
610
611const EMBED_SIZE = {
612 width: 560,
613 height: 315
614}
615
616// Sub folders of cache directory
617const FILES_CACHE = {
618 PREVIEWS: {
619 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
620 MAX_AGE: 1000 * 3600 * 3 // 3 hours
621 },
622 VIDEO_CAPTIONS: {
623 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
624 MAX_AGE: 1000 * 3600 * 3 // 3 hours
625 }
626}
627
628const LRU_CACHE = {
629 USER_TOKENS: {
630 MAX_SIZE: 1000
631 },
632 AVATAR_STATIC: {
633 MAX_SIZE: 500
634 }
635}
636
637const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
638const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
639
640const VIDEO_LIVE = {
641 EXTENSION: '.ts',
642 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
643 SEGMENT_TIME_SECONDS: 4, // 4 seconds
644 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
645 REPLAY_DIRECTORY: 'replay',
646 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
647 RTMP: {
648 CHUNK_SIZE: 60000,
649 GOP_CACHE: true,
650 PING: 60,
651 PING_TIMEOUT: 30,
652 BASE_PATH: 'live'
653 }
654}
655
656const MEMOIZE_TTL = {
657 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
658 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
659 LIVE_ABLE_TO_UPLOAD: 1000 * 60 // 1 minute
660}
661
662const MEMOIZE_LENGTH = {
663 INFO_HASH_EXISTS: 200
664}
665
666const QUEUE_CONCURRENCY = {
667 AVATAR_PROCESS_IMAGE: 3
668}
669
670const REDUNDANCY = {
671 VIDEOS: {
672 RANDOMIZED_FACTOR: 5
673 }
674}
675
676const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
677
678const ASSETS_PATH = {
679 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
680 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
681}
682
683// ---------------------------------------------------------------------------
684
685const CUSTOM_HTML_TAG_COMMENTS = {
686 TITLE: '<!-- title tag -->',
687 DESCRIPTION: '<!-- description tag -->',
688 CUSTOM_CSS: '<!-- custom css tag -->',
689 META_TAGS: '<!-- meta tags -->'
690}
691
692// ---------------------------------------------------------------------------
693
694const FEEDS = {
695 COUNT: 20
696}
697
698const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
699const LOG_FILENAME = 'peertube.log'
700const AUDIT_LOG_FILENAME = 'peertube-audit.log'
701
702// ---------------------------------------------------------------------------
703
704const TRACKER_RATE_LIMITS = {
705 INTERVAL: 60000 * 5, // 5 minutes
706 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
707 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
708 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
709}
710
711const P2P_MEDIA_LOADER_PEER_VERSION = 2
712
713// ---------------------------------------------------------------------------
714
715const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
716const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
717
718let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
719
720const DEFAULT_THEME_NAME = 'default'
721const DEFAULT_USER_THEME_NAME = 'instance-default'
722
723// ---------------------------------------------------------------------------
724
725const SEARCH_INDEX = {
726 ROUTES: {
727 VIDEOS: '/api/v1/search/videos',
728 VIDEO_CHANNELS: '/api/v1/search/video-channels'
729 }
730}
731
732// ---------------------------------------------------------------------------
733
734// Special constants for a test instance
735if (isTestInstance() === true) {
736 PRIVATE_RSA_KEY_SIZE = 1024
737
738 ACTOR_FOLLOW_SCORE.BASE = 20
739
740 REMOTE_SCHEME.HTTP = 'http'
741 REMOTE_SCHEME.WS = 'ws'
742
743 STATIC_MAX_AGE.SERVER = '0'
744
745 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
746 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
747 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
748 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
749
750 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
751 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
752
753 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
754 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
755 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
756 SCHEDULER_INTERVALS_MS.removeOldViews = 5000
757 SCHEDULER_INTERVALS_MS.updateVideos = 5000
758 SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
759 SCHEDULER_INTERVALS_MS.updateInboxStats = 5000
760 REPEAT_JOBS['videos-views'] = { every: 5000 }
761
762 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
763
764 VIEW_LIFETIME.VIDEO = 1000 // 1 second
765 VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
766 CONTACT_FORM_LIFETIME = 1000 // 1 second
767
768 JOB_ATTEMPTS['email'] = 1
769
770 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
771 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
772 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
773 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
774
775 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
776
777 VIDEO_LIVE.CLEANUP_DELAY = 5000
778 VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
779 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
780}
781
782updateWebserverUrls()
783updateWebserverConfig()
784
785registerConfigChangedHandler(() => {
786 updateWebserverUrls()
787 updateWebserverConfig()
788})
789
790// ---------------------------------------------------------------------------
791
792const FILES_CONTENT_HASH = {
793 MANIFEST: generateContentHash(),
794 FAVICON: generateContentHash(),
795 LOGO: generateContentHash()
796}
797
798// ---------------------------------------------------------------------------
799
800export {
801 WEBSERVER,
802 API_VERSION,
803 VIDEO_LIVE,
804 PEERTUBE_VERSION,
805 LAZY_STATIC_PATHS,
806 SEARCH_INDEX,
807 HLS_REDUNDANCY_DIRECTORY,
808 P2P_MEDIA_LOADER_PEER_VERSION,
809 AVATARS_SIZE,
810 ACCEPT_HEADERS,
811 BCRYPT_SALT_SIZE,
812 TRACKER_RATE_LIMITS,
813 FILES_CACHE,
814 LOG_FILENAME,
815 CONSTRAINTS_FIELDS,
816 EMBED_SIZE,
817 REDUNDANCY,
818 JOB_CONCURRENCY,
819 JOB_ATTEMPTS,
820 LAST_MIGRATION_VERSION,
821 OAUTH_LIFETIME,
822 CUSTOM_HTML_TAG_COMMENTS,
823 BROADCAST_CONCURRENCY,
824 AUDIT_LOG_FILENAME,
825 PAGINATION,
826 ACTOR_FOLLOW_SCORE,
827 PREVIEWS_SIZE,
828 REMOTE_SCHEME,
829 VIDEO_TRANSCODING_ENCODERS,
830 FOLLOW_STATES,
831 DEFAULT_USER_THEME_NAME,
832 SERVER_ACTOR_NAME,
833 PLUGIN_GLOBAL_CSS_FILE_NAME,
834 PLUGIN_GLOBAL_CSS_PATH,
835 PRIVATE_RSA_KEY_SIZE,
836 ROUTE_CACHE_LIFETIME,
837 SORTABLE_COLUMNS,
838 HLS_STREAMING_PLAYLIST_DIRECTORY,
839 FEEDS,
840 JOB_TTL,
841 DEFAULT_THEME_NAME,
842 NSFW_POLICY_TYPES,
843 STATIC_MAX_AGE,
844 STATIC_PATHS,
845 VIDEO_IMPORT_TIMEOUT,
846 VIDEO_PLAYLIST_TYPES,
847 MAX_LOGS_OUTPUT_CHARACTERS,
848 ACTIVITY_PUB,
849 ACTIVITY_PUB_ACTOR_TYPES,
850 THUMBNAILS_SIZE,
851 VIDEO_CATEGORIES,
852 MEMOIZE_LENGTH,
853 VIDEO_LANGUAGES,
854 VIDEO_PRIVACIES,
855 VIDEO_LICENCES,
856 VIDEO_STATES,
857 QUEUE_CONCURRENCY,
858 VIDEO_RATE_TYPES,
859 JOB_PRIORITY,
860 VIDEO_TRANSCODING_FPS,
861 FFMPEG_NICE,
862 ABUSE_STATES,
863 VIDEO_CHANNELS,
864 LRU_CACHE,
865 JOB_REQUEST_TIMEOUT,
866 USER_PASSWORD_RESET_LIFETIME,
867 USER_PASSWORD_CREATE_LIFETIME,
868 MEMOIZE_TTL,
869 USER_EMAIL_VERIFY_LIFETIME,
870 OVERVIEWS,
871 SCHEDULER_INTERVALS_MS,
872 REPEAT_JOBS,
873 STATIC_DOWNLOAD_PATHS,
874 MIMETYPES,
875 CRAWL_REQUEST_CONCURRENCY,
876 DEFAULT_AUDIO_RESOLUTION,
877 JOB_COMPLETED_LIFETIME,
878 HTTP_SIGNATURE,
879 VIDEO_IMPORT_STATES,
880 VIEW_LIFETIME,
881 CONTACT_FORM_LIFETIME,
882 VIDEO_PLAYLIST_PRIVACIES,
883 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
884 ASSETS_PATH,
885 FILES_CONTENT_HASH,
886 loadLanguages,
887 buildLanguages,
888 generateContentHash
889}
890
891// ---------------------------------------------------------------------------
892
893function buildVideoMimetypeExt () {
894 const data = {
895 // streamable formats that warrant cross-browser compatibility
896 'video/webm': '.webm',
897 // We'll add .ogg if additional extensions are enabled
898 // We could add .ogg here but since it could be an audio file,
899 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
900 'video/ogg': [ '.ogv' ],
901 'video/mp4': '.mp4'
902 }
903
904 if (CONFIG.TRANSCODING.ENABLED) {
905 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
906 data['video/ogg'].push('.ogg')
907
908 Object.assign(data, {
909 'video/x-matroska': '.mkv',
910
911 // Developed by Apple
912 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
913 'video/x-m4v': '.m4v',
914 'video/m4v': '.m4v',
915
916 // Developed by the Adobe Flash Platform
917 'video/x-flv': '.flv',
918 'video/x-f4v': '.f4v', // replacement for flv
919
920 // Developed by Microsoft
921 'video/x-ms-wmv': '.wmv',
922 'video/x-msvideo': '.avi',
923 'video/avi': '.avi',
924
925 // Developed by 3GPP
926 // common video formats for cell phones
927 'video/3gpp': [ '.3gp', '.3gpp' ],
928 'video/3gpp2': [ '.3g2', '.3gpp2' ],
929
930 // Developed by FFmpeg/Mplayer
931 'application/x-nut': '.nut',
932
933 // The standard video format used by many Sony and Panasonic HD camcorders.
934 // It is also used for storing high definition video on Blu-ray discs.
935 'video/mp2t': '.mts',
936 'video/m2ts': '.m2ts',
937
938 // Old formats reliant on MPEG-1/MPEG-2
939 'video/mpv': '.mpv',
940 'video/mpeg2': '.m2v',
941 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
942 'video/dvd': '.vob',
943
944 // Could be anything
945 'application/octet-stream': null,
946 'application/mxf': '.mxf' // often used as exchange format by editing software
947 })
948 }
949
950 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
951 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
952 }
953 }
954
955 return data
956}
957
958function updateWebserverUrls () {
959 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
960 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
961 WEBSERVER.WS = CONFIG.WEBSERVER.WS
962
963 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
964 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
965 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
966
967 WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
968}
969
970function updateWebserverConfig () {
971 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
972 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
973
974 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
975
976 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
977
978 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
979}
980
981function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
982 const result: { [id: string]: string } = {}
983
984 for (const mimetype of Object.keys(obj)) {
985 const value = obj[mimetype]
986 if (!value) continue
987
988 const extensions = Array.isArray(value) ? value : [ value ]
989
990 for (const extension of extensions) {
991 result[extension] = mimetype
992 }
993 }
994
995 return result
996}
997
998function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
999 return Object.keys(obj)
1000 .map(m => `(${m})`)
1001 .join('|')
1002}
1003
1004function loadLanguages () {
1005 Object.assign(VIDEO_LANGUAGES, buildLanguages())
1006}
1007
1008function buildLanguages () {
1009 const iso639 = require('iso-639-3')
1010
1011 const languages: { [id: string]: string } = {}
1012
1013 const additionalLanguages = {
1014 sgn: true, // Sign languages (macro language)
1015 ase: true, // American sign language
1016 sdl: true, // Arabian sign language
1017 bfi: true, // British sign language
1018 bzs: true, // Brazilian sign language
1019 csl: true, // Chinese sign language
1020 cse: true, // Czech sign language
1021 dsl: true, // Danish sign language
1022 fsl: true, // French sign language
1023 gsg: true, // German sign language
1024 pks: true, // Pakistan sign language
1025 jsl: true, // Japanese sign language
1026 sfs: true, // South African sign language
1027 swl: true, // Swedish sign language
1028 rsl: true, // Russian sign language
1029
1030 kab: true, // Kabyle
1031
1032 epo: true, // Esperanto
1033 tlh: true, // Klingon
1034 jbo: true, // Lojban
1035 avk: true // Kotava
1036 }
1037
1038 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1039 iso639
1040 .filter(l => {
1041 return (l.iso6391 !== undefined && l.type === 'living') ||
1042 additionalLanguages[l.iso6393] === true
1043 })
1044 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1045
1046 // Override Occitan label
1047 languages['oc'] = 'Occitan'
1048 languages['el'] = 'Greek'
1049
1050 return languages
1051}
1052
1053function generateContentHash () {
1054 return randomBytes(20).toString('hex')
1055}