]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Update bullmq
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
5a921e7b 1import { RepeatOptions } from 'bullmq'
a3e5f804 2import { Encoding, randomBytes } from 'crypto'
0223291c 3import { invert } from 'lodash'
6dd9de95 4import { join } from 'path'
c55e3d72 5import { randomInt, root } from '@shared/core-utils'
d95d1559
C
6import {
7 AbuseState,
0223291c 8 JobType,
f959b518 9 UserRegistrationState,
2a491182 10 VideoChannelSyncState,
d95d1559
C
11 VideoImportState,
12 VideoPrivacy,
d95d1559
C
13 VideoRateType,
14 VideoResolution,
0223291c
C
15 VideoState,
16 VideoTranscodingFPS
d95d1559 17} from '../../shared/models'
0223291c 18import { ActivityPubActorType } from '../../shared/models/activitypub'
d0800f76 19import { ActorImageType, FollowState } from '../../shared/models/actors'
0883b324 20import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
418d092a 21import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
df0b219d 22import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
0223291c 23// Do not use barrels, remain constants as independent as possible
9452d4fd 24import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
6dd9de95 25import { CONFIG, registerConfigChangedHandler } from './config'
ee9e7b61 26
9f6bae3a
C
27// ---------------------------------------------------------------------------
28
f008e9f3 29const LAST_MIGRATION_VERSION = 755
5804c0db
C
30
31// ---------------------------------------------------------------------------
32
f0f5567b 33const API_VERSION = 'v1'
db4b15f2 34const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
9f10b292 35
1194e8b4 36const PAGINATION = {
e0b56b74
C
37 GLOBAL: {
38 COUNT: {
39 DEFAULT: 15,
40 MAX: 100
41 }
42 },
43 OUTBOX: {
44 COUNT: {
45 MAX: 50
46 }
1194e8b4
C
47 }
48}
9f6bae3a 49
6dd9de95
C
50const WEBSERVER = {
51 URL: '',
52 HOST: '',
53 SCHEME: '',
54 WS: '',
55 HOSTNAME: '',
c6c0fa6c 56 PORT: 0,
df1db951
C
57 RTMP_URL: '',
58 RTMPS_URL: ''
6dd9de95
C
59}
60
9f6bae3a
C
61// Sortable columns per schema
62const SORTABLE_COLUMNS = {
87a0cac6 63 ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
06a05d5f 64 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 65 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 66 JOBS: [ 'createdAt' ],
72c7248b 67 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
ed31c059 68 VIDEO_IMPORTS: [ 'createdAt' ],
2a491182 69 VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
0f8d00e3 70
c1125bca 71 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
0f8d00e3
C
72 VIDEO_COMMENTS: [ 'createdAt' ],
73
c100a614 74 VIDEO_RATES: [ 'createdAt' ],
7a7724e6 75 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
4beda9e1 76
9593a78a
C
77 INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
78 INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
4beda9e1
C
79 ACCOUNT_FOLLOWERS: [ 'createdAt' ],
80 CHANNEL_FOLLOWERS: [ 'createdAt' ],
57c36b27 81
f959b518
C
82 USER_REGISTRATIONS: [ 'createdAt', 'state' ],
83
3d4e112d 84 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
9a629c6e 85
5fb2e288 86 // Don't forget to update peertube-search-index with the same values
2fd59d7d 87 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
7ad9b984 88 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
37a44fc9 89 VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
7ad9b984 90
d95d1559
C
91 ABUSES: [ 'id', 'createdAt', 'state' ],
92
7ad9b984 93 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
cef534ed
C
94 SERVERS_BLOCKLIST: [ 'createdAt' ],
95
654a188f 96 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
418d092a 97
49cff3a4 98 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
ad91e700 99
6702a1b2
C
100 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
101
b764380a
C
102 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
103
104 VIDEO_REDUNDANCIES: [ 'name' ]
9f6bae3a 105}
9f10b292 106
fd4484f1 107const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
108 FEEDS: '15 minutes',
109 ROBOTS: '2 hours',
2feebf3e 110 SITEMAP: '1 day',
5447516b 111 SECURITYTXT: '2 hours',
3f6d68d9 112 NODEINFO: '10 minutes',
aad0ec24 113 DNT_POLICY: '1 week',
fd4484f1 114 ACTIVITY_PUB: {
3f6d68d9 115 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
4b5384f6 116 },
6c5f0d3a 117 STATS: '4 hours',
118 WELL_KNOWN: '1 day'
fd4484f1
C
119}
120
9f6bae3a 121// ---------------------------------------------------------------------------
26d7d31b 122
60650c77
C
123// Number of points we add/remove after a successful/bad request
124const ACTOR_FOLLOW_SCORE = {
225a89c2
C
125 PENALTY: -10,
126 BONUS: 10,
60650c77
C
127 BASE: 1000,
128 MAX: 10000
225a89c2
C
129}
130
131const FOLLOW_STATES: { [ id: string ]: FollowState } = {
132 PENDING: 'pending',
927fa4b1
C
133 ACCEPTED: 'accepted',
134 REJECTED: 'rejected'
225a89c2
C
135}
136
137const REMOTE_SCHEME = {
138 HTTP: 'https',
139 WS: 'wss'
140}
141
b764380a 142const JOB_ATTEMPTS: { [id in JobType]: number } = {
9db437c8 143 'activitypub-http-broadcast': 1,
f27b7a75 144 'activitypub-http-broadcast-parallel': 1,
9db437c8
C
145 'activitypub-http-unicast': 1,
146 'activitypub-http-fetcher': 2,
5350fd8e 147 'activitypub-follow': 5,
74d249bc 148 'activitypub-cleaner': 1,
0138af92 149 'video-file-import': 1,
a0327eed 150 'video-transcoding': 1,
fbad87b0 151 'video-import': 1,
6b616860 152 'email': 5,
8795d6f2 153 'actor-keys': 3,
51353d9a 154 'videos-views-stats': 1,
b764380a 155 'activitypub-refresher': 1,
a5cf76af 156 'video-redundancy': 1,
0305db28 157 'video-live-ending': 1,
92e66e04 158 'video-studio-edition': 1,
f012319a 159 'manage-video-torrent': 1,
2a491182
F
160 'video-channel-import': 1,
161 'after-video-channel-import': 1,
bd911b54
C
162 'move-to-object-storage': 3,
163 'notify': 1,
164 'federate-video': 1
225a89c2 165}
74d249bc
C
166// Excluded keys are jobs that can be configured by admins
167const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
94a5ff8a 168 'activitypub-http-broadcast': 1,
f27b7a75 169 'activitypub-http-broadcast-parallel': 30,
b7113ff7 170 'activitypub-http-unicast': 30,
60520c7c 171 'activitypub-http-fetcher': 3,
74d249bc 172 'activitypub-cleaner': 1,
ab4d4db4 173 'activitypub-follow': 1,
0138af92 174 'video-file-import': 1,
6b616860 175 'email': 5,
8795d6f2 176 'actor-keys': 1,
51353d9a 177 'videos-views-stats': 1,
b764380a 178 'activitypub-refresher': 1,
a5cf76af 179 'video-redundancy': 1,
0305db28 180 'video-live-ending': 10,
92e66e04 181 'video-studio-edition': 1,
f012319a 182 'manage-video-torrent': 1,
bd911b54 183 'move-to-object-storage': 1,
2a491182
F
184 'video-channel-import': 1,
185 'after-video-channel-import': 1,
bd911b54
C
186 'notify': 5,
187 'federate-video': 3
225a89c2 188}
b764380a 189const JOB_TTL: { [id in JobType]: number } = {
2b86fe72 190 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
f27b7a75 191 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
2b86fe72 192 'activitypub-http-unicast': 60000 * 10, // 10 minutes
d694b193 193 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
2b86fe72 194 'activitypub-follow': 60000 * 10, // 10 minutes
74d249bc 195 'activitypub-cleaner': 1000 * 3600, // 1 hour
2b86fe72 196 'video-file-import': 1000 * 3600, // 1 hour
a0327eed 197 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
92e66e04 198 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
3eba7ab8 199 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
6b616860 200 'email': 60000 * 10, // 10 minutes
8795d6f2 201 'actor-keys': 60000 * 20, // 20 minutes
51353d9a 202 'videos-views-stats': undefined, // Unlimited
b764380a 203 'activitypub-refresher': 60000 * 10, // 10 minutes
a5cf76af 204 'video-redundancy': 1000 * 3600 * 3, // 3 hours
0305db28 205 'video-live-ending': 1000 * 60 * 10, // 10 minutes
f012319a 206 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
2a491182
F
207 'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
208 'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
209 'after-video-channel-import': 60000 * 5, // 5 minutes
bd911b54 210 'notify': 60000 * 5, // 5 minutes
2a491182 211 'federate-video': 60000 * 5 // 5 minutes
2b86fe72 212}
5a921e7b 213const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
51353d9a 214 'videos-views-stats': {
182082f5 215 pattern: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
74d249bc
C
216 },
217 'activitypub-cleaner': {
182082f5 218 pattern: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
6b616860
C
219 }
220}
77d7e851 221const JOB_PRIORITY = {
a6e37eeb 222 TRANSCODING: 100
77d7e851 223}
6b616860 224
67bd004d 225const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 226const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
f1569117
C
227
228const AP_CLEANER = {
229 CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
7a4fd56c 230 UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
f1569117
C
231 PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
232}
233
4c99953a
C
234const REQUEST_TIMEOUTS = {
235 DEFAULT: 7000, // 7 seconds
236 FILE: 30000, // 30 seconds
237 REDUNDANCY: JOB_TTL['video-redundancy']
238}
239
c3b21b68
C
240const JOB_REMOVAL_OPTIONS = {
241 COUNT: 10000, // Max jobs to store
242
243 SUCCESS: { // Success jobs
244 'DEFAULT': parseDurationToMs('2 days'),
245
246 'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
247 'activitypub-http-unicast': parseDurationToMs('1 hour'),
248 'videos-views-stats': parseDurationToMs('3 hours'),
249 'activitypub-refresher': parseDurationToMs('10 hours')
250 },
251
252 FAILURE: { // Failed job
253 DEFAULT: parseDurationToMs('7 days')
254 }
255}
256
7630e1c8 257const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
225a89c2 258
8f0bc73d 259const SCHEDULER_INTERVALS_MS = {
61953742
C
260 ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
261 REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
262 UPDATE_VIDEOS: 60000, // 1 minute
263 YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
b2111066 264 GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
51353d9a 265 VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
61953742
C
266 CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
267 CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
268 AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
269 REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
270 REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
271 UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
2a491182
F
272 REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
273 CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
2baea0c7 274}
60650c77 275
225a89c2
C
276// ---------------------------------------------------------------------------
277
503c6f44 278const CONSTRAINTS_FIELDS = {
e4c55619 279 USERS: {
9f7a1953 280 NAME: { min: 1, max: 120 }, // Length
d23e6a1c 281 DESCRIPTION: { min: 3, max: 1000 }, // Length
d0ce42c1 282 USERNAME: { min: 1, max: 50 }, // Length
b0f9f39e 283 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 284 VIDEO_QUOTA: { min: -1 },
bee0abff 285 VIDEO_QUOTA_DAILY: { min: -1 },
3caf77d3 286 VIDEO_LANGUAGES: { max: 500 }, // Array length
eacb25c4 287 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 288 },
d95d1559 289 ABUSES: {
1506307f
C
290 REASON: { min: 2, max: 3000 }, // Length
291 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
55fa55a9 292 },
edbc9325
C
293 ABUSE_MESSAGES: {
294 MESSAGE: { min: 2, max: 3000 } // Length
295 },
f959b518
C
296 USER_REGISTRATIONS: {
297 REASON_MESSAGE: { min: 2, max: 3000 }, // Length
298 MODERATOR_MESSAGE: { min: 2, max: 3000 } // Length
299 },
26b7305a
C
300 VIDEO_BLACKLIST: {
301 REASON: { min: 2, max: 300 } // Length
302 },
72c7248b 303 VIDEO_CHANNELS: {
9f7a1953 304 NAME: { min: 1, max: 120 }, // Length
d23e6a1c
BY
305 DESCRIPTION: { min: 3, max: 1000 }, // Length
306 SUPPORT: { min: 3, max: 1000 }, // Length
2a491182 307 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
e34c85e5 308 URL: { min: 3, max: 2000 } // Length
72c7248b 309 },
2a491182
F
310 VIDEO_CHANNEL_SYNCS: {
311 EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
312 },
40e87e9e
C
313 VIDEO_CAPTIONS: {
314 CAPTION_FILE: {
f4001cf4 315 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e 316 FILE_SIZE: {
ce7c099f 317 max: 20 * 1024 * 1024 // 20MB
40e87e9e
C
318 }
319 }
320 },
fbad87b0 321 VIDEO_IMPORTS: {
ce33919c
C
322 URL: { min: 3, max: 2000 }, // Length
323 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
324 TORRENT_FILE: {
325 EXTNAME: [ '.torrent' ],
326 FILE_SIZE: {
327 max: 1024 * 200 // 200 KB
328 }
329 }
fbad87b0 330 },
c48e82b5
C
331 VIDEOS_REDUNDANCY: {
332 URL: { min: 3, max: 2000 } // Length
333 },
5c6d985f
C
334 VIDEO_RATES: {
335 URL: { min: 3, max: 2000 } // Length
336 },
e4c55619 337 VIDEOS: {
a265f7f3 338 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 339 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 340 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 341 DESCRIPTION: { min: 3, max: 10000 }, // Length
d23e6a1c 342 SUPPORT: { min: 3, max: 1000 }, // Length
ac81d1a0 343 IMAGE: {
e08ff02a 344 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
ac81d1a0 345 FILE_SIZE: {
a13df19d 346 max: 4 * 1024 * 1024 // 4MB
ac81d1a0
C
347 }
348 },
536598cf 349 EXTNAME: [] as string[],
0e1dc3e7 350 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 351 DURATION: { min: 0 }, // Number
a265f7f3
C
352 TAGS: { min: 0, max: 5 }, // Number of total tags
353 TAG: { min: 2, max: 30 }, // Length
e4c87ec2
C
354 VIEWS: { min: 0 },
355 LIKES: { min: 0 },
93e1258c 356 DISLIKES: { min: 0 },
c6c0fa6c 357 FILE_SIZE: { min: -1 },
f6d6e7f8 358 PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
e34c85e5
C
359 URL: { min: 3, max: 2000 } // Length
360 },
418d092a
C
361 VIDEO_PLAYLISTS: {
362 NAME: { min: 1, max: 120 }, // Length
363 DESCRIPTION: { min: 3, max: 1000 }, // Length
364 URL: { min: 3, max: 2000 }, // Length
365 IMAGE: {
366 EXTNAME: [ '.jpg', '.jpeg' ],
367 FILE_SIZE: {
a13df19d 368 max: 4 * 1024 * 1024 // 4MB
418d092a
C
369 }
370 }
371 },
01de67b9 372 ACTORS: {
e34c85e5
C
373 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
374 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3 375 URL: { min: 3, max: 2000 }, // Length
2cb03dc1 376 IMAGE: {
e08ff02a 377 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
01de67b9 378 FILE_SIZE: {
a13df19d 379 max: 4 * 1024 * 1024 // 4MB
01de67b9 380 }
c5911fd3 381 }
e4c87ec2
C
382 },
383 VIDEO_EVENTS: {
384 COUNT: { min: 0 }
6d852470 385 },
bf1f6508 386 VIDEO_COMMENTS: {
298b3fd3 387 TEXT: { min: 1, max: 10000 }, // Length
6d852470 388 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
389 },
390 VIDEO_SHARE: {
391 URL: { min: 3, max: 2000 } // Length
a4101923
C
392 },
393 CONTACT_FORM: {
394 FROM_NAME: { min: 1, max: 120 }, // Length
395 BODY: { min: 3, max: 5000 } // Length
345da516
C
396 },
397 PLUGINS: {
398 NAME: { min: 1, max: 214 }, // Length
399 DESCRIPTION: { min: 1, max: 20000 } // Length
2735a154
C
400 },
401 COMMONS: {
402 URL: { min: 5, max: 2000 } // Length
c729caf6 403 },
92e66e04 404 VIDEO_STUDIO: {
c729caf6
C
405 TASKS: { min: 1, max: 10 }, // Number of tasks
406 CUT_TIME: { min: 0 } // Value
42b40636
C
407 },
408 LOGS: {
409 CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
cfb5edbd 410 CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
42b40636
C
411 CLIENT_META: { min: 1, max: 5000 }, // Length
412 CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
e4c55619
C
413 }
414}
415
c655c9ef 416const VIEW_LIFETIME = {
51353d9a 417 VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
f53e1fcd 418 VIEWER_COUNTER: 60000 * 2, // 2 minutes
b2111066 419 VIEWER_STATS: 60000 * 60 // 1 hour
e4bf7856
C
420}
421
42e6a7a7 422const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
b2111066 423
a4101923
C
424let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
425
edb4ffc7 426const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
f7bb2bb5 427 MIN: 1,
a1587156
C
428 STANDARD: [ 24, 25, 30 ],
429 HD_STANDARD: [ 50, 60 ],
c729caf6 430 AUDIO_MERGE: 25,
3a6f351b
C
431 AVERAGE: 30,
432 MAX: 60,
433 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 434}
b5c0e955 435
536598cf
C
436const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
437
ee9e7b61 438const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
439 LIKE: 'like',
440 DISLIKE: 'dislike'
441}
442
80bc88c1 443const FFMPEG_NICE: { [ id: string ]: number } = {
7abb6060
RK
444 // parent process defaults to niceness = 0
445 // reminder: lower = higher priority, max value is 19, lowest is -20
a4a8cd39
C
446 LIVE: 5, // prioritize over VOD and THUMBNAIL
447 THUMBNAIL: 10,
7abb6060 448 VOD: 15
80bc88c1
J
449}
450
6e07c3de
C
451const VIDEO_CATEGORIES = {
452 1: 'Music',
453 2: 'Films',
454 3: 'Vehicles',
455 4: 'Art',
456 5: 'Sports',
457 6: 'Travels',
458 7: 'Gaming',
459 8: 'People',
460 9: 'Comedy',
461 10: 'Entertainment',
6f2ae7a1 462 11: 'News & Politics',
40298b02 463 12: 'How To',
6e07c3de
C
464 13: 'Education',
465 14: 'Activism',
466 15: 'Science & Technology',
467 16: 'Animals',
468 17: 'Kids',
469 18: 'Food'
470}
471
6f0c39e2
C
472// See https://creativecommons.org/licenses/?lang=en
473const VIDEO_LICENCES = {
474 1: 'Attribution',
475 2: 'Attribution - Share Alike',
476 3: 'Attribution - No Derivatives',
477 4: 'Attribution - Non Commercial',
478 5: 'Attribution - Non Commercial - Share Alike',
479 6: 'Attribution - Non Commercial - No Derivatives',
480 7: 'Public Domain Dedication'
481}
482
a1587156 483const VIDEO_LANGUAGES: { [id: string]: string } = {}
3092476e 484
c6c0fa6c 485const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
a1587156
C
486 [VideoPrivacy.PUBLIC]: 'Public',
487 [VideoPrivacy.UNLISTED]: 'Unlisted',
488 [VideoPrivacy.PRIVATE]: 'Private',
489 [VideoPrivacy.INTERNAL]: 'Internal'
fd45e8f4
C
490}
491
c6c0fa6c 492const VIDEO_STATES: { [ id in VideoState ]: string } = {
a1587156
C
493 [VideoState.PUBLISHED]: 'Published',
494 [VideoState.TO_TRANSCODE]: 'To transcode',
c6c0fa6c
C
495 [VideoState.TO_IMPORT]: 'To import',
496 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
0305db28 497 [VideoState.LIVE_ENDED]: 'Livestream ended',
4e29f4fe 498 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
dbd9fb44 499 [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
c729caf6
C
500 [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
501 [VideoState.TO_EDIT]: 'To edit*'
fbad87b0
C
502}
503
c6c0fa6c 504const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
a1587156
C
505 [VideoImportState.FAILED]: 'Failed',
506 [VideoImportState.PENDING]: 'Pending',
2158ac90 507 [VideoImportState.SUCCESS]: 'Success',
419b520c
C
508 [VideoImportState.REJECTED]: 'Rejected',
509 [VideoImportState.CANCELLED]: 'Cancelled',
510 [VideoImportState.PROCESSING]: 'Processing'
2186386c
C
511}
512
2a491182
F
513const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
514 [VideoChannelSyncState.FAILED]: 'Failed',
515 [VideoChannelSyncState.SYNCED]: 'Synchronized',
516 [VideoChannelSyncState.PROCESSING]: 'Processing',
517 [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
518}
519
c6c0fa6c 520const ABUSE_STATES: { [ id in AbuseState ]: string } = {
d95d1559
C
521 [AbuseState.PENDING]: 'Pending',
522 [AbuseState.REJECTED]: 'Rejected',
523 [AbuseState.ACCEPTED]: 'Accepted'
268eebed
C
524}
525
f959b518
C
526const USER_REGISTRATION_STATES: { [ id in UserRegistrationState ]: string } = {
527 [UserRegistrationState.PENDING]: 'Pending',
528 [UserRegistrationState.REJECTED]: 'Rejected',
529 [UserRegistrationState.ACCEPTED]: 'Accepted'
530}
531
c6c0fa6c 532const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
a1587156
C
533 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
534 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
535 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
418d092a
C
536}
537
c6c0fa6c 538const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
a1587156
C
539 [VideoPlaylistType.REGULAR]: 'Regular',
540 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
df0b219d
C
541}
542
14e2014a 543const MIMETYPES = {
536598cf
C
544 AUDIO: {
545 MIMETYPE_EXT: {
546 'audio/mpeg': '.mp3',
547 'audio/mp3': '.mp3',
4b7a20d8 548
536598cf
C
549 'application/ogg': '.ogg',
550 'audio/ogg': '.ogg',
4b7a20d8 551
99d362de
C
552 'audio/x-ms-wma': '.wma',
553 'audio/wav': '.wav',
e622db05 554 'audio/x-wav': '.wav',
4b7a20d8 555
99d362de 556 'audio/x-flac': '.flac',
b056afe0 557 'audio/flac': '.flac',
4b7a20d8
C
558
559 'audio/vnd.dlna.adts': '.aac',
e622db05 560 'audio/aac': '.aac',
4b7a20d8 561
9556ce48 562 'audio/m4a': '.m4a',
e072fb1e 563 'audio/mp4': '.m4a',
9556ce48 564 'audio/x-m4a': '.m4a',
4b7a20d8
C
565
566 'audio/vnd.dolby.dd-raw': '.ac3',
b056afe0 567 'audio/ac3': '.ac3'
536598cf
C
568 },
569 EXT_MIMETYPE: null as { [ id: string ]: string }
570 },
14e2014a 571 VIDEO: {
30bc55c8
C
572 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
573 MIMETYPES_REGEX: null as string,
14e2014a
C
574 EXT_MIMETYPE: null as { [ id: string ]: string }
575 },
576 IMAGE: {
577 MIMETYPE_EXT: {
578 'image/png': '.png',
2cb03dc1
C
579 'image/gif': '.gif',
580 'image/webp': '.webp',
14e2014a
C
581 'image/jpg': '.jpg',
582 'image/jpeg': '.jpg'
c6de3a85
C
583 },
584 EXT_MIMETYPE: null as { [ id: string ]: string }
14e2014a
C
585 },
586 VIDEO_CAPTIONS: {
587 MIMETYPE_EXT: {
588 'text/vtt': '.vtt',
2f26030d
C
589 'application/x-subrip': '.srt',
590 'text/plain': '.srt'
14e2014a
C
591 }
592 },
593 TORRENT: {
594 MIMETYPE_EXT: {
595 'application/x-bittorrent': '.torrent'
596 }
597 }
990b6a0b 598}
536598cf 599MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
c6de3a85 600MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
990b6a0b 601
62549e6c
C
602const BINARY_CONTENT_TYPES = new Set([
603 'binary/octet-stream',
604 'application/octet-stream',
605 'application/x-binary'
606])
607
9f6bae3a
C
608// ---------------------------------------------------------------------------
609
2d3741d6
C
610const OVERVIEWS = {
611 VIDEOS: {
1a471091 612 SAMPLE_THRESHOLD: 6,
764a9657 613 SAMPLES_COUNT: 20
2d3741d6
C
614 }
615}
616
617// ---------------------------------------------------------------------------
618
50d6de9c 619const SERVER_ACTOR_NAME = 'peertube'
350e31d6 620
e4f97bab 621const ACTIVITY_PUB = {
1b5b10d1
C
622 POTENTIAL_ACCEPT_HEADERS: [
623 'application/activity+json',
9a8cbd82
C
624 'application/ld+json',
625 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 626 ],
1b5b10d1 627 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 628 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 629 COLLECTION_ITEMS_PER_PAGE: 10,
4d9ae8f7 630 FETCH_PAGE_LIMIT: 2000,
20494f12 631 URL_MIME_TYPES: {
536598cf 632 VIDEO: [] as string[],
20494f12
C
633 TORRENT: [ 'application/x-bittorrent' ],
634 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 635 },
2ccaeeb3 636 MAX_RECURSION_COMMENTS: 100,
0e0c745b 637 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
9f79ade6
C
638 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
639 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
e4f97bab
C
640}
641
50d6de9c
C
642const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
643 GROUP: 'Group',
644 PERSON: 'Person',
47581df0
C
645 APPLICATION: 'Application',
646 ORGANIZATION: 'Organization',
647 SERVICE: 'Service'
50d6de9c
C
648}
649
41f2ebae
C
650const HTTP_SIGNATURE = {
651 HEADER_NAME: 'signature',
652 ALGORITHM: 'rsa-sha256',
543affef 653 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
f67d7574 654 CLOCK_SKEW_SECONDS: 1800
41f2ebae
C
655}
656
9f6bae3a
C
657// ---------------------------------------------------------------------------
658
04b8c3fb 659let PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 660
9f6bae3a
C
661// Password encryption
662const BCRYPT_SALT_SIZE = 10
a877d5ac 663
a3e5f804
C
664const ENCRYPTION = {
665 ALGORITHM: 'aes-256-cbc',
666 IV: 16,
667 SALT: 'peertube',
668 ENCODING: 'hex' as Encoding
669}
670
f88ee4a9 671const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
45f1bd72 672const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
ecb4e35f 673
56f47830
C
674const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
675
f959b518 676const EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
d9eaee39 677
6dd9de95 678const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
0883b324
C
679 DO_NOT_LIST: 'do_not_list',
680 BLUR: 'blur',
681 DISPLAY: 'display'
682}
683
bdfbd4f1
C
684// ---------------------------------------------------------------------------
685
052937db
C
686// Express static paths (router)
687const STATIC_PATHS = {
f285faa0 688 THUMBNAILS: '/static/thumbnails/',
3545e72c 689
c5911fd3 690 WEBSEED: '/static/webseed/',
3545e72c
C
691 PRIVATE_WEBSEED: '/static/webseed/private/',
692
b9fffa29 693 REDUNDANCY: '/static/redundancy/',
3545e72c 694
9c6ca37f 695 STREAMING_PLAYLISTS: {
3545e72c
C
696 HLS: '/static/streaming-playlists/hls',
697 PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
90a8bd30 698 }
052937db 699}
02756fbd
C
700const STATIC_DOWNLOAD_PATHS = {
701 TORRENTS: '/download/torrents/',
d7a25329
C
702 VIDEOS: '/download/videos/',
703 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
02756fbd 704}
557b13ae 705const LAZY_STATIC_PATHS = {
f4796856 706 BANNERS: '/lazy-static/banners/',
557b13ae 707 AVATARS: '/lazy-static/avatars/',
20dcfd74 708 PREVIEWS: '/lazy-static/previews/',
90a8bd30
C
709 VIDEO_CAPTIONS: '/lazy-static/video-captions/',
710 TORRENTS: '/lazy-static/torrents/'
557b13ae 711}
9ab330b9
C
712const OBJECT_STORAGE_PROXY_PATHS = {
713 PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
714
715 STREAMING_PLAYLISTS: {
716 PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
717 }
718}
052937db 719
dc009132 720// Cache control
a1587156 721const STATIC_MAX_AGE = {
cd4cb177 722 SERVER: '2h',
90a8bd30 723 LAZY_SERVER: '2d',
cd4cb177
C
724 CLIENT: '30d'
725}
dc009132 726
cbe2f7c3 727// Videos thumbnail size
d8755eed 728const THUMBNAILS_SIZE = {
4363ce0e
C
729 width: 280,
730 height: 157,
ca6d3622 731 minWidth: 150
d8755eed
C
732}
733const PREVIEWS_SIZE = {
b345a804 734 width: 850,
ca6d3622
C
735 height: 480,
736 minWidth: 400
164174a6 737}
99b75748 738const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
d0800f76 739 [ActorImageType.AVATAR]: [
740 {
741 width: 120,
742 height: 120
743 },
744 {
745 width: 48,
746 height: 48
747 }
748 ],
749 [ActorImageType.BANNER]: [
750 {
751 width: 1920,
752 height: 317 // 6/1 ratio
753 }
754 ]
e8e12200 755}
164174a6
C
756
757const EMBED_SIZE = {
758 width: 560,
759 height: 315
d8755eed 760}
cbe2f7c3 761
980246ea 762// Sub folders of cache directory
d74d29ad 763const FILES_CACHE = {
f4001cf4
C
764 PREVIEWS: {
765 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
766 MAX_AGE: 1000 * 3600 * 3 // 3 hours
767 },
768 VIDEO_CAPTIONS: {
769 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
770 MAX_AGE: 1000 * 3600 * 3 // 3 hours
90a8bd30
C
771 },
772 TORRENTS: {
773 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
774 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
775 }
776}
777
557b13ae 778const LRU_CACHE = {
d74d29ad 779 USER_TOKENS: {
557b13ae
C
780 MAX_SIZE: 1000
781 },
f4796856 782 ACTOR_IMAGE_STATIC: {
557b13ae 783 MAX_SIZE: 500
3545e72c
C
784 },
785 STATIC_VIDEO_FILES_RIGHTS_CHECK: {
786 MAX_SIZE: 5000,
787 TTL: parseDurationToMs('10 seconds')
788 },
789 VIDEO_TOKENS: {
790 MAX_SIZE: 100_000,
791 TTL: parseDurationToMs('8 hours')
1fed9cb8
C
792 },
793 TRACKER_IPS: {
794 MAX_SIZE: 100_000
d74d29ad
C
795 }
796}
797
3545e72c
C
798const DIRECTORIES = {
799 RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
800
801 HLS_STREAMING_PLAYLIST: {
802 PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
803 PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
804 },
805
806 VIDEOS: {
807 PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
808 PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
809 },
810
811 HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
812}
09209296 813
276250f0
RK
814const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
815
c6c0fa6c
C
816const VIDEO_LIVE = {
817 EXTENSION: '.ts',
fb719404 818 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
f443a746
C
819 SEGMENT_TIME_SECONDS: {
820 DEFAULT_LATENCY: 4, // 4 seconds
821 SMALL_LATENCY: 2 // 2 seconds
822 },
fb719404 823 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
937581b8 824 REPLAY_DIRECTORY: 'replay',
e14de000 825 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
00b87c57 826 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
c6c0fa6c
C
827 RTMP: {
828 CHUNK_SIZE: 60000,
829 GOP_CACHE: true,
830 PING: 60,
831 PING_TIMEOUT: 30,
832 BASE_PATH: 'live'
833 }
834}
835
7348b1fd 836const MEMOIZE_TTL = {
35f28e94 837 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
22926eaf 838 INFO_HASH_EXISTS: 1000 * 60, // 1 minute
aa2ce188 839 VIDEO_DURATION: 1000 * 10, // 10 seconds
00b87c57 840 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
630d0a1b
C
841 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
842 GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
35f28e94
C
843}
844
845const MEMOIZE_LENGTH = {
aa2ce188
C
846 INFO_HASH_EXISTS: 200,
847 VIDEO_DURATION: 200
7348b1fd
C
848}
849
c53853ca
C
850const WORKER_THREADS = {
851 DOWNLOAD_IMAGE: {
852 CONCURRENCY: 3,
853 MAX_THREADS: 1
3a54605d
C
854 },
855 PROCESS_IMAGE: {
856 CONCURRENCY: 1,
857 MAX_THREADS: 5
c53853ca 858 }
557b13ae
C
859}
860
c48e82b5
C
861const REDUNDANCY = {
862 VIDEOS: {
c48e82b5
C
863 RANDOMIZED_FACTOR: 5
864 }
865}
866
e12a0092 867const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
56f47830
C
868const OTP = {
869 HEADER_NAME: 'x-peertube-otp',
870 HEADER_REQUIRED_VALUE: 'required; app'
871}
4f491371 872
536598cf 873const ASSETS_PATH = {
c6c0fa6c
C
874 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
875 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
536598cf
C
876}
877
bdfbd4f1
C
878// ---------------------------------------------------------------------------
879
e032aec9
C
880const CUSTOM_HTML_TAG_COMMENTS = {
881 TITLE: '<!-- title tag -->',
882 DESCRIPTION: '<!-- description tag -->',
883 CUSTOM_CSS: '<!-- custom css tag -->',
aea0b0e7
C
884 META_TAGS: '<!-- meta tags -->',
885 SERVER_CONFIG: '<!-- server config -->'
e032aec9 886}
709756b8 887
fd8710b8 888const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
566c125d
C
889const LOG_FILENAME = 'peertube.log'
890const AUDIT_LOG_FILENAME = 'peertube-audit.log'
fd8710b8 891
4195cd2b
C
892// ---------------------------------------------------------------------------
893
9b67da3d
C
894const TRACKER_RATE_LIMITS = {
895 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 896 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
db48de85 897 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
1fed9cb8 898 BLOCK_IP_LIFETIME: parseDurationToMs('3 minutes')
9b67da3d
C
899}
900
ae9bbed4
C
901const P2P_MEDIA_LOADER_PEER_VERSION = 2
902
9b67da3d
C
903// ---------------------------------------------------------------------------
904
345da516
C
905const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
906const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
907
9107d791
C
908let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
909
ffb321be
C
910const DEFAULT_THEME_NAME = 'default'
911const DEFAULT_USER_THEME_NAME = 'instance-default'
7cd4d2ba 912
345da516
C
913// ---------------------------------------------------------------------------
914
5fb2e288
C
915const SEARCH_INDEX = {
916 ROUTES: {
917 VIDEOS: '/api/v1/search/videos',
918 VIDEO_CHANNELS: '/api/v1/search/video-channels'
919 }
920}
921
922// ---------------------------------------------------------------------------
923
b2111066 924const STATS_TIMESERIE = {
f40712ab 925 MAX_DAYS: 365 * 10 // Around 10 years
b2111066
C
926}
927
928// ---------------------------------------------------------------------------
929
9f10b292 930// Special constants for a test instance
9452d4fd
C
931if (process.env.PRODUCTION_CONSTANTS !== 'true') {
932 if (isTestOrDevInstance()) {
933 PRIVATE_RSA_KEY_SIZE = 1024
04b8c3fb 934
9452d4fd 935 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 936
9452d4fd
C
937 REMOTE_SCHEME.HTTP = 'http'
938 REMOTE_SCHEME.WS = 'ws'
3cd0734f 939
9452d4fd 940 STATIC_MAX_AGE.SERVER = '0'
3cd0734f 941
9452d4fd
C
942 SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
943 SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
944 SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
945 SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
946 SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
947 SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
948 SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
949 SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
3cd0734f 950
9452d4fd 951 REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
3cd0734f 952
9452d4fd
C
953 REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
954 AP_CLEANER.PERIOD = 5000
f1569117 955
9452d4fd 956 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
f1569117 957
9452d4fd 958 CONTACT_FORM_LIFETIME = 1000 // 1 second
2baea0c7 959
9452d4fd 960 JOB_ATTEMPTS['email'] = 1
c48e82b5 961
9452d4fd
C
962 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
963 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
964 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
965 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
3cd0734f 966
9452d4fd 967 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
c3b21b68
C
968
969 JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
9452d4fd
C
970 }
971
972 if (isTestInstance()) {
973 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
974 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
975 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
976 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
f4001cf4 977
9452d4fd
C
978 CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
979 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
9107d791 980
9452d4fd
C
981 VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
982 VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
31c82cd9 983
9452d4fd
C
984 VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
985 VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
986 VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
987 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
988 }
9f10b292
C
989}
990
14e2014a 991updateWebserverUrls()
536598cf 992updateWebserverConfig()
225a89c2 993
6dd9de95
C
994registerConfigChangedHandler(() => {
995 updateWebserverUrls()
996 updateWebserverConfig()
997})
998
9f10b292
C
999// ---------------------------------------------------------------------------
1000
caf2aaf4
K
1001const FILES_CONTENT_HASH = {
1002 MANIFEST: generateContentHash(),
1003 FAVICON: generateContentHash(),
1004 LOGO: generateContentHash()
1005}
1006
1007// ---------------------------------------------------------------------------
1008
c729caf6
C
1009const VIDEO_FILTERS = {
1010 WATERMARK: {
1011 SIZE_RATIO: 1 / 10,
1012 HORIZONTAL_MARGIN_RATIO: 1 / 20,
1013 VERTICAL_MARGIN_RATIO: 1 / 20
1014 }
1015}
1016
1017// ---------------------------------------------------------------------------
1018
65fcc311 1019export {
6dd9de95 1020 WEBSERVER,
9f6bae3a 1021 API_VERSION,
a3e5f804 1022 ENCRYPTION,
c6c0fa6c 1023 VIDEO_LIVE,
66170ca8 1024 PEERTUBE_VERSION,
557b13ae 1025 LAZY_STATIC_PATHS,
9ab330b9 1026 OBJECT_STORAGE_PROXY_PATHS,
5fb2e288 1027 SEARCH_INDEX,
3545e72c 1028 DIRECTORIES,
276250f0 1029 RESUMABLE_UPLOAD_SESSION_LIFETIME,
ae9bbed4 1030 P2P_MEDIA_LOADER_PEER_VERSION,
2cb03dc1 1031 ACTOR_IMAGES_SIZE,
4f491371 1032 ACCEPT_HEADERS,
9f6bae3a 1033 BCRYPT_SALT_SIZE,
9b67da3d 1034 TRACKER_RATE_LIMITS,
d74d29ad 1035 FILES_CACHE,
566c125d 1036 LOG_FILENAME,
9f6bae3a 1037 CONSTRAINTS_FIELDS,
164174a6 1038 EMBED_SIZE,
c48e82b5 1039 REDUNDANCY,
94a5ff8a
C
1040 JOB_CONCURRENCY,
1041 JOB_ATTEMPTS,
f1569117 1042 AP_CLEANER,
b769007f 1043 LAST_MIGRATION_VERSION,
e032aec9 1044 CUSTOM_HTML_TAG_COMMENTS,
b2111066 1045 STATS_TIMESERIE,
f55e5a7b 1046 BROADCAST_CONCURRENCY,
566c125d 1047 AUDIT_LOG_FILENAME,
1194e8b4 1048 PAGINATION,
60650c77 1049 ACTOR_FOLLOW_SCORE,
f285faa0
C
1050 PREVIEWS_SIZE,
1051 REMOTE_SCHEME,
7a7724e6 1052 FOLLOW_STATES,
ffb321be 1053 DEFAULT_USER_THEME_NAME,
50d6de9c 1054 SERVER_ACTOR_NAME,
56f47830 1055 TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
345da516
C
1056 PLUGIN_GLOBAL_CSS_FILE_NAME,
1057 PLUGIN_GLOBAL_CSS_PATH,
e4f97bab 1058 PRIVATE_RSA_KEY_SIZE,
c729caf6 1059 VIDEO_FILTERS,
fd4484f1 1060 ROUTE_CACHE_LIFETIME,
9f6bae3a 1061 SORTABLE_COLUMNS,
2b86fe72 1062 JOB_TTL,
ffb321be 1063 DEFAULT_THEME_NAME,
0883b324 1064 NSFW_POLICY_TYPES,
dc009132 1065 STATIC_MAX_AGE,
a6375e69 1066 STATIC_PATHS,
cf9166cf 1067 VIDEO_IMPORT_TIMEOUT,
df0b219d 1068 VIDEO_PLAYLIST_TYPES,
fd8710b8 1069 MAX_LOGS_OUTPUT_CHARACTERS,
e4f97bab 1070 ACTIVITY_PUB,
50d6de9c 1071 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 1072 THUMBNAILS_SIZE,
6e07c3de 1073 VIDEO_CATEGORIES,
35f28e94 1074 MEMOIZE_LENGTH,
3092476e 1075 VIDEO_LANGUAGES,
fd45e8f4 1076 VIDEO_PRIVACIES,
6f0c39e2 1077 VIDEO_LICENCES,
2186386c 1078 VIDEO_STATES,
c53853ca 1079 WORKER_THREADS,
0d0e8dd0 1080 VIDEO_RATE_TYPES,
77d7e851 1081 JOB_PRIORITY,
a7977280 1082 VIDEO_TRANSCODING_FPS,
80bc88c1 1083 FFMPEG_NICE,
d95d1559 1084 ABUSE_STATES,
f959b518 1085 USER_REGISTRATION_STATES,
557b13ae 1086 LRU_CACHE,
4c99953a 1087 REQUEST_TIMEOUTS,
b2111066 1088 MAX_LOCAL_VIEWER_WATCH_SECTIONS,
ecb4e35f 1089 USER_PASSWORD_RESET_LIFETIME,
45f1bd72 1090 USER_PASSWORD_CREATE_LIFETIME,
7348b1fd 1091 MEMOIZE_TTL,
f959b518 1092 EMAIL_VERIFY_LIFETIME,
2d3741d6 1093 OVERVIEWS,
2baea0c7 1094 SCHEDULER_INTERVALS_MS,
6b616860 1095 REPEAT_JOBS,
02756fbd 1096 STATIC_DOWNLOAD_PATHS,
14e2014a 1097 MIMETYPES,
f6eebcb3 1098 CRAWL_REQUEST_CONCURRENCY,
536598cf 1099 DEFAULT_AUDIO_RESOLUTION,
62549e6c 1100 BINARY_CONTENT_TYPES,
c3b21b68 1101 JOB_REMOVAL_OPTIONS,
41f2ebae 1102 HTTP_SIGNATURE,
fbad87b0 1103 VIDEO_IMPORT_STATES,
2a491182 1104 VIDEO_CHANNEL_SYNC_STATE,
e4bf7856 1105 VIEW_LIFETIME,
a4101923 1106 CONTACT_FORM_LIFETIME,
418d092a 1107 VIDEO_PLAYLIST_PRIVACIES,
9107d791 1108 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
536598cf 1109 ASSETS_PATH,
caf2aaf4 1110 FILES_CONTENT_HASH,
56f47830 1111 OTP,
74dc3bca 1112 loadLanguages,
caf2aaf4
K
1113 buildLanguages,
1114 generateContentHash
9f10b292 1115}
fd206f0b
C
1116
1117// ---------------------------------------------------------------------------
1118
14e2014a
C
1119function buildVideoMimetypeExt () {
1120 const data = {
fccbbc1a 1121 // streamable formats that warrant cross-browser compatibility
14e2014a 1122 'video/webm': '.webm',
30bc55c8
C
1123 // We'll add .ogg if additional extensions are enabled
1124 // We could add .ogg here but since it could be an audio file,
1125 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
1126 'video/ogg': [ '.ogv' ],
14e2014a
C
1127 'video/mp4': '.mp4'
1128 }
1129
536598cf
C
1130 if (CONFIG.TRANSCODING.ENABLED) {
1131 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
30bc55c8
C
1132 data['video/ogg'].push('.ogg')
1133
536598cf 1134 Object.assign(data, {
536598cf 1135 'video/x-matroska': '.mkv',
fccbbc1a
RK
1136
1137 // Developed by Apple
b056afe0 1138 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
c37a52b0 1139 'video/x-m4v': '.m4v',
fccbbc1a
RK
1140 'video/m4v': '.m4v',
1141
1142 // Developed by the Adobe Flash Platform
1143 'video/x-flv': '.flv',
1144 'video/x-f4v': '.f4v', // replacement for flv
1145
1146 // Developed by Microsoft
1147 'video/x-ms-wmv': '.wmv',
1148 'video/x-msvideo': '.avi',
1149 'video/avi': '.avi',
1150
1151 // Developed by 3GPP
1152 // common video formats for cell phones
b056afe0
RK
1153 'video/3gpp': [ '.3gp', '.3gpp' ],
1154 'video/3gpp2': [ '.3g2', '.3gpp2' ],
fccbbc1a
RK
1155
1156 // Developed by FFmpeg/Mplayer
1157 'application/x-nut': '.nut',
1158
1159 // The standard video format used by many Sony and Panasonic HD camcorders.
1160 // It is also used for storing high definition video on Blu-ray discs.
1161 'video/mp2t': '.mts',
4b7a20d8
C
1162 'video/vnd.dlna.mpeg-tts': '.mts',
1163
fccbbc1a
RK
1164 'video/m2ts': '.m2ts',
1165
1166 // Old formats reliant on MPEG-1/MPEG-2
1167 'video/mpv': '.mpv',
1168 'video/mpeg2': '.m2v',
b056afe0
RK
1169 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
1170 'video/dvd': '.vob',
fccbbc1a 1171
26469f9e
C
1172 // Could be anything
1173 'application/octet-stream': null,
fccbbc1a 1174 'application/mxf': '.mxf' // often used as exchange format by editing software
536598cf
C
1175 })
1176 }
1177
1178 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
1179 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
1180 }
14e2014a
C
1181 }
1182
1183 return data
1184}
1185
1186function updateWebserverUrls () {
6dd9de95
C
1187 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
1188 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
6dd9de95 1189 WEBSERVER.WS = CONFIG.WEBSERVER.WS
c6c0fa6c
C
1190
1191 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
6dd9de95
C
1192 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
1193 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
c6c0fa6c 1194
cfbe6be5
C
1195 const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1196 const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
1197
1198 WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
1199 WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
fd206f0b
C
1200}
1201
14e2014a 1202function updateWebserverConfig () {
14e2014a 1203 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
30bc55c8
C
1204 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
1205
536598cf
C
1206 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
1207
30bc55c8
C
1208 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
1209
1210 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
1211}
1212
1213function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
1214 const result: { [id: string]: string } = {}
1215
1216 for (const mimetype of Object.keys(obj)) {
1217 const value = obj[mimetype]
1218 if (!value) continue
1219
1220 const extensions = Array.isArray(value) ? value : [ value ]
1221
1222 for (const extension of extensions) {
1223 result[extension] = mimetype
1224 }
1225 }
1226
1227 return result
14e2014a
C
1228}
1229
30bc55c8
C
1230function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
1231 return Object.keys(obj)
1232 .map(m => `(${m})`)
1233 .join('|')
14e2014a
C
1234}
1235
74dc3bca 1236function loadLanguages () {
8f0bc73d 1237 Object.assign(VIDEO_LANGUAGES, buildLanguages())
74dc3bca
C
1238}
1239
9d3ef9fe
C
1240function buildLanguages () {
1241 const iso639 = require('iso-639-3')
1242
a1587156 1243 const languages: { [id: string]: string } = {}
9d3ef9fe 1244
1d94c154 1245 const additionalLanguages = {
a1587156
C
1246 sgn: true, // Sign languages (macro language)
1247 ase: true, // American sign language
c7c5f8d0 1248 asq: true, // Austrian sign language
a1587156
C
1249 sdl: true, // Arabian sign language
1250 bfi: true, // British sign language
1251 bzs: true, // Brazilian sign language
1252 csl: true, // Chinese sign language
1253 cse: true, // Czech sign language
1254 dsl: true, // Danish sign language
1255 fsl: true, // French sign language
1256 gsg: true, // German sign language
1257 pks: true, // Pakistan sign language
1258 jsl: true, // Japanese sign language
1259 sfs: true, // South African sign language
1260 swl: true, // Swedish sign language
07c01b31
C
1261 rsl: true, // Russian sign language
1262
1263 kab: true, // Kabyle
a1587156 1264
23fdb0ff
C
1265 lat: true, // Latin
1266
a1587156
C
1267 epo: true, // Esperanto
1268 tlh: true, // Klingon
1269 jbo: true, // Lojban
81547acb
FC
1270 avk: true, // Kotava
1271
1272 zxx: true // No linguistic content (ISO-639-2)
1d94c154 1273 }
9d3ef9fe
C
1274
1275 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1276 iso639
1277 .filter(l => {
4fdeef81 1278 return (l.iso6391 !== undefined && l.type === 'living') ||
a1587156 1279 additionalLanguages[l.iso6393] === true
9d3ef9fe 1280 })
a1587156 1281 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
9d3ef9fe 1282
db6d617d 1283 // Override Occitan label
a1587156
C
1284 languages['oc'] = 'Occitan'
1285 languages['el'] = 'Greek'
978489b6 1286 languages['tok'] = 'Toki Pona'
db6d617d 1287
8f7d35fd
C
1288 // Chinese languages
1289 languages['zh-Hans'] = 'Simplified Chinese'
1290 languages['zh-Hant'] = 'Traditional Chinese'
1291
9d3ef9fe
C
1292 return languages
1293}
caf2aaf4
K
1294
1295function generateContentHash () {
1296 return randomBytes(20).toString('hex')
1297}
53023be3
C
1298
1299function getIntEnv (path: string) {
1300 if (process.env[path]) return parseInt(process.env[path])
1301
1302 return undefined
1303}