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