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