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