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