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