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