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