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