]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Fix broken migration introduced in 2.2.0-rc.1
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
6dd9de95 1import { join } from 'path'
536598cf 2import { JobType, VideoRateType, VideoResolution, VideoState } from '../../shared/models'
50d6de9c 3import { ActivityPubActorType } from '../../shared/models/activitypub'
225a89c2 4import { FollowState } from '../../shared/models/actors'
edb4ffc7 5import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
e02643f3 6// Do not use barrels, remain constants as independent as possible
a1587156 7import { isTestInstance, sanitizeHost, sanitizeUrl, root } from '../helpers/core-utils'
0883b324 8import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
28be8916 9import { invert } from 'lodash'
6b616860 10import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
418d092a 11import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
df0b219d 12import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
6dd9de95 13import { CONFIG, registerConfigChangedHandler } from './config'
ee9e7b61 14
9f6bae3a
C
15// ---------------------------------------------------------------------------
16
d2a5c4e1 17const LAST_MIGRATION_VERSION = 510
5804c0db
C
18
19// ---------------------------------------------------------------------------
20
f0f5567b 21const API_VERSION = 'v1'
9fa6ca16 22const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
9f10b292 23
1194e8b4 24const PAGINATION = {
e0b56b74
C
25 GLOBAL: {
26 COUNT: {
27 DEFAULT: 15,
28 MAX: 100
29 }
30 },
31 OUTBOX: {
32 COUNT: {
33 MAX: 50
34 }
1194e8b4
C
35 }
36}
9f6bae3a 37
6dd9de95
C
38const WEBSERVER = {
39 URL: '',
40 HOST: '',
41 SCHEME: '',
42 WS: '',
43 HOSTNAME: '',
44 PORT: 0
45}
46
9f6bae3a
C
47// Sortable columns per schema
48const SORTABLE_COLUMNS = {
aa3796bd 49 USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt' ],
06a05d5f 50 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 51 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 52 JOBS: [ 'createdAt' ],
26b7305a 53 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
72c7248b 54 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
ed31c059 55 VIDEO_IMPORTS: [ 'createdAt' ],
c1125bca 56 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
c100a614 57 VIDEO_RATES: [ 'createdAt' ],
7a7724e6 58 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
cb5ce4cb
C
59 FOLLOWERS: [ 'createdAt', 'state', 'score' ],
60 FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
57c36b27 61
2fd59d7d 62 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending' ],
9a629c6e 63
2fd59d7d 64 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
7ad9b984
C
65 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
66
67 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
cef534ed
C
68 SERVERS_BLOCKLIST: [ 'createdAt' ],
69
418d092a
C
70 USER_NOTIFICATIONS: [ 'createdAt' ],
71
ad91e700
C
72 VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ],
73
6702a1b2
C
74 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
75
b764380a
C
76 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
77
78 VIDEO_REDUNDANCIES: [ 'name' ]
9f6bae3a 79}
9f10b292 80
2f372a86 81const OAUTH_LIFETIME = {
ff193d5e 82 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2f372a86
C
83 REFRESH_TOKEN: 1209600 // 2 weeks
84}
85
fd4484f1 86const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
87 FEEDS: '15 minutes',
88 ROBOTS: '2 hours',
2feebf3e 89 SITEMAP: '1 day',
5447516b 90 SECURITYTXT: '2 hours',
3f6d68d9 91 NODEINFO: '10 minutes',
aad0ec24 92 DNT_POLICY: '1 week',
fd4484f1 93 ACTIVITY_PUB: {
3f6d68d9 94 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
4b5384f6
C
95 },
96 STATS: '4 hours'
fd4484f1
C
97}
98
9f6bae3a 99// ---------------------------------------------------------------------------
26d7d31b 100
60650c77
C
101// Number of points we add/remove after a successful/bad request
102const ACTOR_FOLLOW_SCORE = {
225a89c2
C
103 PENALTY: -10,
104 BONUS: 10,
60650c77
C
105 BASE: 1000,
106 MAX: 10000
225a89c2
C
107}
108
109const FOLLOW_STATES: { [ id: string ]: FollowState } = {
110 PENDING: 'pending',
111 ACCEPTED: 'accepted'
112}
113
114const REMOTE_SCHEME = {
115 HTTP: 'https',
116 WS: 'wss'
117}
118
b764380a 119const JOB_ATTEMPTS: { [id in JobType]: number } = {
94a5ff8a
C
120 'activitypub-http-broadcast': 5,
121 'activitypub-http-unicast': 5,
122 'activitypub-http-fetcher': 5,
5350fd8e 123 'activitypub-follow': 5,
0138af92 124 'video-file-import': 1,
a0327eed 125 'video-transcoding': 1,
fbad87b0 126 'video-import': 1,
6b616860 127 'email': 5,
04b8c3fb 128 'videos-views': 1,
b764380a
C
129 'activitypub-refresher': 1,
130 'video-redundancy': 1
225a89c2 131}
b764380a 132const JOB_CONCURRENCY: { [id in JobType]: number } = {
94a5ff8a
C
133 'activitypub-http-broadcast': 1,
134 'activitypub-http-unicast': 5,
135 'activitypub-http-fetcher': 1,
ab4d4db4 136 'activitypub-follow': 1,
0138af92 137 'video-file-import': 1,
a0327eed 138 'video-transcoding': 1,
fbad87b0 139 'video-import': 1,
6b616860 140 'email': 5,
04b8c3fb 141 'videos-views': 1,
b764380a
C
142 'activitypub-refresher': 1,
143 'video-redundancy': 1
225a89c2 144}
b764380a 145const JOB_TTL: { [id in JobType]: number } = {
2b86fe72
C
146 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
147 'activitypub-http-unicast': 60000 * 10, // 10 minutes
d694b193 148 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
2b86fe72
C
149 'activitypub-follow': 60000 * 10, // 10 minutes
150 'video-file-import': 1000 * 3600, // 1 hour
a0327eed 151 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
d694b193 152 'video-import': 1000 * 3600 * 2, // 2 hours
6b616860 153 'email': 60000 * 10, // 10 minutes
04b8c3fb 154 'videos-views': undefined, // Unlimited
b764380a
C
155 'activitypub-refresher': 60000 * 10, // 10 minutes
156 'video-redundancy': 1000 * 3600 * 3 // 3 hours
2b86fe72 157}
6b616860
C
158const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
159 'videos-views': {
04b8c3fb 160 cron: '1 * * * *' // At 1 minute past the hour
6b616860
C
161 }
162}
163
71e3dfda 164const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 165const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
71e3dfda 166const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
71e3dfda 167const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
cf9166cf 168const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
225a89c2 169
8f0bc73d 170const SCHEDULER_INTERVALS_MS = {
2f5c6b2f 171 actorFollowScores: 60000 * 60, // 1 hour
bbe0f064 172 removeOldJobs: 60000 * 60, // 1 hour
ce32426b 173 updateVideos: 60000, // 1 minute
8f0bc73d 174 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
d133f385 175 checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
6f1b4fa4 176 autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
cda03765 177 removeOldViews: 60000 * 60 * 24, // 1 day
8f0bc73d 178 removeOldHistory: 60000 * 60 * 24 // 1 day
2baea0c7 179}
60650c77 180
225a89c2
C
181// ---------------------------------------------------------------------------
182
503c6f44 183const CONSTRAINTS_FIELDS = {
e4c55619 184 USERS: {
9f7a1953 185 NAME: { min: 1, max: 120 }, // Length
d23e6a1c 186 DESCRIPTION: { min: 3, max: 1000 }, // Length
d0ce42c1 187 USERNAME: { min: 1, max: 50 }, // Length
b0f9f39e 188 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 189 VIDEO_QUOTA: { min: -1 },
bee0abff 190 VIDEO_QUOTA_DAILY: { min: -1 },
3caf77d3 191 VIDEO_LANGUAGES: { max: 500 }, // Array length
eacb25c4 192 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 193 },
55fa55a9 194 VIDEO_ABUSES: {
1506307f
C
195 REASON: { min: 2, max: 3000 }, // Length
196 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
55fa55a9 197 },
26b7305a
C
198 VIDEO_BLACKLIST: {
199 REASON: { min: 2, max: 300 } // Length
200 },
72c7248b 201 VIDEO_CHANNELS: {
9f7a1953 202 NAME: { min: 1, max: 120 }, // Length
d23e6a1c
BY
203 DESCRIPTION: { min: 3, max: 1000 }, // Length
204 SUPPORT: { min: 3, max: 1000 }, // Length
e34c85e5 205 URL: { min: 3, max: 2000 } // Length
72c7248b 206 },
40e87e9e
C
207 VIDEO_CAPTIONS: {
208 CAPTION_FILE: {
f4001cf4 209 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
210 FILE_SIZE: {
211 max: 2 * 1024 * 1024 // 2MB
212 }
213 }
214 },
fbad87b0 215 VIDEO_IMPORTS: {
ce33919c
C
216 URL: { min: 3, max: 2000 }, // Length
217 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
218 TORRENT_FILE: {
219 EXTNAME: [ '.torrent' ],
220 FILE_SIZE: {
221 max: 1024 * 200 // 200 KB
222 }
223 }
fbad87b0 224 },
c48e82b5
C
225 VIDEOS_REDUNDANCY: {
226 URL: { min: 3, max: 2000 } // Length
227 },
5c6d985f
C
228 VIDEO_RATES: {
229 URL: { min: 3, max: 2000 } // Length
230 },
e4c55619 231 VIDEOS: {
a265f7f3 232 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 233 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 234 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 235 DESCRIPTION: { min: 3, max: 10000 }, // Length
d23e6a1c 236 SUPPORT: { min: 3, max: 1000 }, // Length
ac81d1a0
C
237 IMAGE: {
238 EXTNAME: [ '.jpg', '.jpeg' ],
239 FILE_SIZE: {
240 max: 2 * 1024 * 1024 // 2MB
241 }
242 },
536598cf 243 EXTNAME: [] as string[],
0e1dc3e7 244 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 245 DURATION: { min: 0 }, // Number
a265f7f3
C
246 TAGS: { min: 0, max: 5 }, // Number of total tags
247 TAG: { min: 2, max: 30 }, // Length
e4c55619 248 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
249 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
250 VIEWS: { min: 0 },
251 LIKES: { min: 0 },
93e1258c 252 DISLIKES: { min: 0 },
c60774b0 253 FILE_SIZE: { min: 10 },
e34c85e5
C
254 URL: { min: 3, max: 2000 } // Length
255 },
418d092a
C
256 VIDEO_PLAYLISTS: {
257 NAME: { min: 1, max: 120 }, // Length
258 DESCRIPTION: { min: 3, max: 1000 }, // Length
259 URL: { min: 3, max: 2000 }, // Length
260 IMAGE: {
261 EXTNAME: [ '.jpg', '.jpeg' ],
262 FILE_SIZE: {
263 max: 2 * 1024 * 1024 // 2MB
264 }
265 }
266 },
01de67b9 267 ACTORS: {
e34c85e5
C
268 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
269 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
270 URL: { min: 3, max: 2000 }, // Length
271 AVATAR: {
01de67b9
C
272 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
273 FILE_SIZE: {
274 max: 2 * 1024 * 1024 // 2MB
275 }
c5911fd3 276 }
e4c87ec2
C
277 },
278 VIDEO_EVENTS: {
279 COUNT: { min: 0 }
6d852470 280 },
bf1f6508 281 VIDEO_COMMENTS: {
298b3fd3 282 TEXT: { min: 1, max: 10000 }, // Length
6d852470 283 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
284 },
285 VIDEO_SHARE: {
286 URL: { min: 3, max: 2000 } // Length
a4101923
C
287 },
288 CONTACT_FORM: {
289 FROM_NAME: { min: 1, max: 120 }, // Length
290 BODY: { min: 3, max: 5000 } // Length
345da516
C
291 },
292 PLUGINS: {
293 NAME: { min: 1, max: 214 }, // Length
294 DESCRIPTION: { min: 1, max: 20000 } // Length
2735a154
C
295 },
296 COMMONS: {
297 URL: { min: 5, max: 2000 } // Length
e4c55619
C
298 }
299}
300
b5c0e955 301let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a4101923
C
302let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
303
edb4ffc7 304const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
a7977280 305 MIN: 10,
a1587156
C
306 STANDARD: [ 24, 25, 30 ],
307 HD_STANDARD: [ 50, 60 ],
3a6f351b
C
308 AVERAGE: 30,
309 MAX: 60,
310 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 311}
b5c0e955 312
536598cf
C
313const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
314
ee9e7b61 315const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
316 LIKE: 'like',
317 DISLIKE: 'dislike'
318}
319
80bc88c1
J
320const FFMPEG_NICE: { [ id: string ]: number } = {
321 THUMBNAIL: 2, // 2 just for don't blocking servers
322 TRANSCODING: 15
323}
324
6e07c3de
C
325const VIDEO_CATEGORIES = {
326 1: 'Music',
327 2: 'Films',
328 3: 'Vehicles',
329 4: 'Art',
330 5: 'Sports',
331 6: 'Travels',
332 7: 'Gaming',
333 8: 'People',
334 9: 'Comedy',
335 10: 'Entertainment',
6f2ae7a1 336 11: 'News & Politics',
40298b02 337 12: 'How To',
6e07c3de
C
338 13: 'Education',
339 14: 'Activism',
340 15: 'Science & Technology',
341 16: 'Animals',
342 17: 'Kids',
343 18: 'Food'
344}
345
6f0c39e2
C
346// See https://creativecommons.org/licenses/?lang=en
347const VIDEO_LICENCES = {
348 1: 'Attribution',
349 2: 'Attribution - Share Alike',
350 3: 'Attribution - No Derivatives',
351 4: 'Attribution - Non Commercial',
352 5: 'Attribution - Non Commercial - Share Alike',
353 6: 'Attribution - Non Commercial - No Derivatives',
354 7: 'Public Domain Dedication'
355}
356
a1587156 357const VIDEO_LANGUAGES: { [id: string]: string } = {}
3092476e 358
fd45e8f4 359const VIDEO_PRIVACIES = {
a1587156
C
360 [VideoPrivacy.PUBLIC]: 'Public',
361 [VideoPrivacy.UNLISTED]: 'Unlisted',
362 [VideoPrivacy.PRIVATE]: 'Private',
363 [VideoPrivacy.INTERNAL]: 'Internal'
fd45e8f4
C
364}
365
2186386c 366const VIDEO_STATES = {
a1587156
C
367 [VideoState.PUBLISHED]: 'Published',
368 [VideoState.TO_TRANSCODE]: 'To transcode',
369 [VideoState.TO_IMPORT]: 'To import'
fbad87b0
C
370}
371
372const VIDEO_IMPORT_STATES = {
a1587156
C
373 [VideoImportState.FAILED]: 'Failed',
374 [VideoImportState.PENDING]: 'Pending',
2158ac90
RK
375 [VideoImportState.SUCCESS]: 'Success',
376 [VideoImportState.REJECTED]: 'Rejected'
2186386c
C
377}
378
268eebed 379const VIDEO_ABUSE_STATES = {
a1587156
C
380 [VideoAbuseState.PENDING]: 'Pending',
381 [VideoAbuseState.REJECTED]: 'Rejected',
382 [VideoAbuseState.ACCEPTED]: 'Accepted'
268eebed
C
383}
384
418d092a 385const VIDEO_PLAYLIST_PRIVACIES = {
a1587156
C
386 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
387 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
388 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
418d092a
C
389}
390
df0b219d 391const VIDEO_PLAYLIST_TYPES = {
a1587156
C
392 [VideoPlaylistType.REGULAR]: 'Regular',
393 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
df0b219d
C
394}
395
14e2014a 396const MIMETYPES = {
536598cf
C
397 AUDIO: {
398 MIMETYPE_EXT: {
399 'audio/mpeg': '.mp3',
400 'audio/mp3': '.mp3',
401 'application/ogg': '.ogg',
402 'audio/ogg': '.ogg',
99d362de
C
403 'audio/x-ms-wma': '.wma',
404 'audio/wav': '.wav',
405 'audio/x-flac': '.flac',
536598cf
C
406 'audio/flac': '.flac'
407 },
408 EXT_MIMETYPE: null as { [ id: string ]: string }
409 },
14e2014a 410 VIDEO: {
536598cf 411 MIMETYPE_EXT: null as { [ id: string ]: string },
14e2014a
C
412 EXT_MIMETYPE: null as { [ id: string ]: string }
413 },
414 IMAGE: {
415 MIMETYPE_EXT: {
416 'image/png': '.png',
417 'image/jpg': '.jpg',
418 'image/jpeg': '.jpg'
c6de3a85
C
419 },
420 EXT_MIMETYPE: null as { [ id: string ]: string }
14e2014a
C
421 },
422 VIDEO_CAPTIONS: {
423 MIMETYPE_EXT: {
424 'text/vtt': '.vtt',
2f26030d
C
425 'application/x-subrip': '.srt',
426 'text/plain': '.srt'
14e2014a
C
427 }
428 },
429 TORRENT: {
430 MIMETYPE_EXT: {
431 'application/x-bittorrent': '.torrent'
432 }
433 }
990b6a0b 434}
536598cf 435MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
c6de3a85 436MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
990b6a0b 437
9f6bae3a
C
438// ---------------------------------------------------------------------------
439
2d3741d6
C
440const OVERVIEWS = {
441 VIDEOS: {
1a471091 442 SAMPLE_THRESHOLD: 6,
764a9657 443 SAMPLES_COUNT: 20
2d3741d6
C
444 }
445}
446
a3ce4ae8
C
447const VIDEO_CHANNELS = {
448 MAX_PER_USER: 20
449}
450
2d3741d6
C
451// ---------------------------------------------------------------------------
452
50d6de9c 453const SERVER_ACTOR_NAME = 'peertube'
350e31d6 454
e4f97bab 455const ACTIVITY_PUB = {
1b5b10d1
C
456 POTENTIAL_ACCEPT_HEADERS: [
457 'application/activity+json',
9a8cbd82
C
458 'application/ld+json',
459 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 460 ],
1b5b10d1 461 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 462 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 463 COLLECTION_ITEMS_PER_PAGE: 10,
4d9ae8f7 464 FETCH_PAGE_LIMIT: 2000,
20494f12 465 URL_MIME_TYPES: {
536598cf 466 VIDEO: [] as string[],
20494f12
C
467 TORRENT: [ 'application/x-bittorrent' ],
468 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 469 },
2ccaeeb3 470 MAX_RECURSION_COMMENTS: 100,
0e0c745b 471 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
9f79ade6
C
472 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
473 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
e4f97bab
C
474}
475
50d6de9c
C
476const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
477 GROUP: 'Group',
478 PERSON: 'Person',
47581df0
C
479 APPLICATION: 'Application',
480 ORGANIZATION: 'Organization',
481 SERVICE: 'Service'
50d6de9c
C
482}
483
41f2ebae
C
484const HTTP_SIGNATURE = {
485 HEADER_NAME: 'signature',
486 ALGORITHM: 'rsa-sha256',
f67d7574
C
487 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
488 CLOCK_SKEW_SECONDS: 1800
41f2ebae
C
489}
490
9f6bae3a
C
491// ---------------------------------------------------------------------------
492
04b8c3fb 493let PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 494
9f6bae3a
C
495// Password encryption
496const BCRYPT_SALT_SIZE = 10
a877d5ac 497
f88ee4a9 498const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
45f1bd72 499const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
ecb4e35f 500
d9eaee39
JM
501const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
502
6dd9de95 503const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
0883b324
C
504 DO_NOT_LIST: 'do_not_list',
505 BLUR: 'blur',
506 DISPLAY: 'display'
507}
508
bdfbd4f1
C
509// ---------------------------------------------------------------------------
510
052937db
C
511// Express static paths (router)
512const STATIC_PATHS = {
f285faa0
C
513 PREVIEWS: '/static/previews/',
514 THUMBNAILS: '/static/thumbnails/',
052937db 515 TORRENTS: '/static/torrents/',
c5911fd3 516 WEBSEED: '/static/webseed/',
b9fffa29 517 REDUNDANCY: '/static/redundancy/',
9c6ca37f
C
518 STREAMING_PLAYLISTS: {
519 HLS: '/static/streaming-playlists/hls'
09209296 520 },
40e87e9e
C
521 AVATARS: '/static/avatars/',
522 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 523}
02756fbd
C
524const STATIC_DOWNLOAD_PATHS = {
525 TORRENTS: '/download/torrents/',
d7a25329
C
526 VIDEOS: '/download/videos/',
527 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
02756fbd 528}
557b13ae
C
529const LAZY_STATIC_PATHS = {
530 AVATARS: '/lazy-static/avatars/',
531 PREVIEWS: '/static/previews/',
532 VIDEO_CAPTIONS: '/static/video-captions/'
533}
052937db 534
dc009132 535// Cache control
a1587156 536const STATIC_MAX_AGE = {
cd4cb177
C
537 SERVER: '2h',
538 CLIENT: '30d'
539}
dc009132 540
cbe2f7c3 541// Videos thumbnail size
d8755eed 542const THUMBNAILS_SIZE = {
e5fc7811 543 width: 223,
ca6d3622
C
544 height: 122,
545 minWidth: 150
d8755eed
C
546}
547const PREVIEWS_SIZE = {
b345a804 548 width: 850,
ca6d3622
C
549 height: 480,
550 minWidth: 400
164174a6 551}
e8e12200
C
552const AVATARS_SIZE = {
553 width: 120,
554 height: 120
555}
164174a6
C
556
557const EMBED_SIZE = {
558 width: 560,
559 height: 315
d8755eed 560}
cbe2f7c3 561
980246ea 562// Sub folders of cache directory
d74d29ad 563const FILES_CACHE = {
f4001cf4
C
564 PREVIEWS: {
565 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
566 MAX_AGE: 1000 * 3600 * 3 // 3 hours
567 },
568 VIDEO_CAPTIONS: {
569 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
570 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
571 }
572}
573
557b13ae 574const LRU_CACHE = {
d74d29ad 575 USER_TOKENS: {
557b13ae
C
576 MAX_SIZE: 1000
577 },
578 AVATAR_STATIC: {
579 MAX_SIZE: 500
d74d29ad
C
580 }
581}
582
9c6ca37f 583const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
09209296
C
584const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
585
7348b1fd 586const MEMOIZE_TTL = {
35f28e94
C
587 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
588 INFO_HASH_EXISTS: 1000 * 3600 * 12 // 12 hours
589}
590
591const MEMOIZE_LENGTH = {
592 INFO_HASH_EXISTS: 200
7348b1fd
C
593}
594
557b13ae
C
595const QUEUE_CONCURRENCY = {
596 AVATAR_PROCESS_IMAGE: 3
597}
598
c48e82b5
C
599const REDUNDANCY = {
600 VIDEOS: {
c48e82b5
C
601 RANDOMIZED_FACTOR: 5
602 }
603}
604
e12a0092 605const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 606
536598cf 607const ASSETS_PATH = {
fff2183d 608 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg')
536598cf
C
609}
610
bdfbd4f1
C
611// ---------------------------------------------------------------------------
612
e032aec9
C
613const CUSTOM_HTML_TAG_COMMENTS = {
614 TITLE: '<!-- title tag -->',
615 DESCRIPTION: '<!-- description tag -->',
616 CUSTOM_CSS: '<!-- custom css tag -->',
92bf2f62 617 META_TAGS: '<!-- meta tags -->'
e032aec9 618}
709756b8
C
619
620// ---------------------------------------------------------------------------
621
4195cd2b 622const FEEDS = {
fd4484f1 623 COUNT: 20
4195cd2b
C
624}
625
fd8710b8 626const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
566c125d
C
627const LOG_FILENAME = 'peertube.log'
628const AUDIT_LOG_FILENAME = 'peertube-audit.log'
fd8710b8 629
4195cd2b
C
630// ---------------------------------------------------------------------------
631
9b67da3d
C
632const TRACKER_RATE_LIMITS = {
633 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 634 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
635 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
636}
637
ae9bbed4
C
638const P2P_MEDIA_LOADER_PEER_VERSION = 2
639
9b67da3d
C
640// ---------------------------------------------------------------------------
641
345da516
C
642const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
643const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
644
9107d791
C
645let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
646
ffb321be
C
647const DEFAULT_THEME_NAME = 'default'
648const DEFAULT_USER_THEME_NAME = 'instance-default'
7cd4d2ba 649
345da516
C
650// ---------------------------------------------------------------------------
651
9f10b292
C
652// Special constants for a test instance
653if (isTestInstance() === true) {
04b8c3fb
C
654 PRIVATE_RSA_KEY_SIZE = 1024
655
60650c77 656 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 657
f285faa0
C
658 REMOTE_SCHEME.HTTP = 'http'
659 REMOTE_SCHEME.WS = 'ws'
3cd0734f 660
cd4cb177 661 STATIC_MAX_AGE.SERVER = '0'
3cd0734f 662
c46edbc2 663 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 664 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 665 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
9f79ade6 666 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 667
01de67b9 668 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 669
2f5c6b2f 670 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
2baea0c7 671 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
8f0bc73d 672 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
cda03765 673 SCHEDULER_INTERVALS_MS.removeOldViews = 5000
2baea0c7 674 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6f1b4fa4 675 SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
a1587156 676 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 677
c48e82b5
C
678 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
679
b5c0e955 680 VIDEO_VIEW_LIFETIME = 1000 // 1 second
a4101923 681 CONTACT_FORM_LIFETIME = 1000 // 1 second
3cd0734f 682
a1587156 683 JOB_ATTEMPTS['email'] = 1
f4001cf4 684
d74d29ad 685 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
764a9657
C
686 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
687 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
9107d791
C
688
689 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
9f10b292
C
690}
691
14e2014a 692updateWebserverUrls()
536598cf 693updateWebserverConfig()
225a89c2 694
6dd9de95
C
695registerConfigChangedHandler(() => {
696 updateWebserverUrls()
697 updateWebserverConfig()
698})
699
9f10b292
C
700// ---------------------------------------------------------------------------
701
65fcc311 702export {
6dd9de95 703 WEBSERVER,
9f6bae3a 704 API_VERSION,
66170ca8 705 PEERTUBE_VERSION,
557b13ae 706 LAZY_STATIC_PATHS,
09209296 707 HLS_REDUNDANCY_DIRECTORY,
ae9bbed4 708 P2P_MEDIA_LOADER_PEER_VERSION,
e8e12200 709 AVATARS_SIZE,
4f491371 710 ACCEPT_HEADERS,
9f6bae3a 711 BCRYPT_SALT_SIZE,
9b67da3d 712 TRACKER_RATE_LIMITS,
d74d29ad 713 FILES_CACHE,
566c125d 714 LOG_FILENAME,
9f6bae3a 715 CONSTRAINTS_FIELDS,
164174a6 716 EMBED_SIZE,
c48e82b5 717 REDUNDANCY,
94a5ff8a
C
718 JOB_CONCURRENCY,
719 JOB_ATTEMPTS,
b769007f 720 LAST_MIGRATION_VERSION,
9f6bae3a 721 OAUTH_LIFETIME,
e032aec9 722 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 723 BROADCAST_CONCURRENCY,
566c125d 724 AUDIT_LOG_FILENAME,
1194e8b4 725 PAGINATION,
60650c77 726 ACTOR_FOLLOW_SCORE,
f285faa0
C
727 PREVIEWS_SIZE,
728 REMOTE_SCHEME,
7a7724e6 729 FOLLOW_STATES,
ffb321be 730 DEFAULT_USER_THEME_NAME,
50d6de9c 731 SERVER_ACTOR_NAME,
345da516
C
732 PLUGIN_GLOBAL_CSS_FILE_NAME,
733 PLUGIN_GLOBAL_CSS_PATH,
e4f97bab 734 PRIVATE_RSA_KEY_SIZE,
fd4484f1 735 ROUTE_CACHE_LIFETIME,
9f6bae3a 736 SORTABLE_COLUMNS,
9c6ca37f 737 HLS_STREAMING_PLAYLIST_DIRECTORY,
4195cd2b 738 FEEDS,
2b86fe72 739 JOB_TTL,
ffb321be 740 DEFAULT_THEME_NAME,
0883b324 741 NSFW_POLICY_TYPES,
dc009132 742 STATIC_MAX_AGE,
a6375e69 743 STATIC_PATHS,
cf9166cf 744 VIDEO_IMPORT_TIMEOUT,
df0b219d 745 VIDEO_PLAYLIST_TYPES,
fd8710b8 746 MAX_LOGS_OUTPUT_CHARACTERS,
e4f97bab 747 ACTIVITY_PUB,
50d6de9c 748 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 749 THUMBNAILS_SIZE,
6e07c3de 750 VIDEO_CATEGORIES,
35f28e94 751 MEMOIZE_LENGTH,
3092476e 752 VIDEO_LANGUAGES,
fd45e8f4 753 VIDEO_PRIVACIES,
6f0c39e2 754 VIDEO_LICENCES,
2186386c 755 VIDEO_STATES,
557b13ae 756 QUEUE_CONCURRENCY,
0d0e8dd0 757 VIDEO_RATE_TYPES,
a7977280 758 VIDEO_TRANSCODING_FPS,
80bc88c1 759 FFMPEG_NICE,
268eebed 760 VIDEO_ABUSE_STATES,
a3ce4ae8 761 VIDEO_CHANNELS,
557b13ae 762 LRU_CACHE,
71e3dfda 763 JOB_REQUEST_TIMEOUT,
ecb4e35f 764 USER_PASSWORD_RESET_LIFETIME,
45f1bd72 765 USER_PASSWORD_CREATE_LIFETIME,
7348b1fd 766 MEMOIZE_TTL,
d9eaee39 767 USER_EMAIL_VERIFY_LIFETIME,
2d3741d6 768 OVERVIEWS,
2baea0c7 769 SCHEDULER_INTERVALS_MS,
6b616860 770 REPEAT_JOBS,
02756fbd 771 STATIC_DOWNLOAD_PATHS,
14e2014a 772 MIMETYPES,
f6eebcb3 773 CRAWL_REQUEST_CONCURRENCY,
536598cf 774 DEFAULT_AUDIO_RESOLUTION,
b5c0e955 775 JOB_COMPLETED_LIFETIME,
41f2ebae 776 HTTP_SIGNATURE,
fbad87b0 777 VIDEO_IMPORT_STATES,
7ce44a74 778 VIDEO_VIEW_LIFETIME,
a4101923 779 CONTACT_FORM_LIFETIME,
418d092a 780 VIDEO_PLAYLIST_PRIVACIES,
9107d791 781 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
536598cf 782 ASSETS_PATH,
74dc3bca 783 loadLanguages,
7ce44a74 784 buildLanguages
9f10b292 785}
fd206f0b
C
786
787// ---------------------------------------------------------------------------
788
14e2014a
C
789function buildVideoMimetypeExt () {
790 const data = {
791 'video/webm': '.webm',
792 'video/ogg': '.ogv',
793 'video/mp4': '.mp4'
794 }
795
536598cf
C
796 if (CONFIG.TRANSCODING.ENABLED) {
797 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
798 Object.assign(data, {
799 'video/quicktime': '.mov',
800 'video/x-msvideo': '.avi',
801 'video/x-flv': '.flv',
802 'video/x-matroska': '.mkv',
c37a52b0
C
803 'video/avi': '.avi',
804 'video/x-m4v': '.m4v',
26469f9e
C
805 // Could be anything
806 'application/octet-stream': null,
c37a52b0 807 'video/m4v': '.m4v'
536598cf
C
808 })
809 }
810
811 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
812 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
813 }
14e2014a
C
814 }
815
816 return data
817}
818
819function updateWebserverUrls () {
6dd9de95
C
820 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
821 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
822 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
823 WEBSERVER.WS = CONFIG.WEBSERVER.WS
824 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
825 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
fd206f0b
C
826}
827
14e2014a 828function updateWebserverConfig () {
14e2014a
C
829 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
830 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
536598cf
C
831 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
832
833 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
14e2014a
C
834}
835
836function buildVideosExtname () {
536598cf 837 return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
14e2014a
C
838}
839
74dc3bca 840function loadLanguages () {
8f0bc73d 841 Object.assign(VIDEO_LANGUAGES, buildLanguages())
74dc3bca
C
842}
843
9d3ef9fe
C
844function buildLanguages () {
845 const iso639 = require('iso-639-3')
846
a1587156 847 const languages: { [id: string]: string } = {}
9d3ef9fe 848
1d94c154 849 const additionalLanguages = {
a1587156
C
850 sgn: true, // Sign languages (macro language)
851 ase: true, // American sign language
852 sdl: true, // Arabian sign language
853 bfi: true, // British sign language
854 bzs: true, // Brazilian sign language
855 csl: true, // Chinese sign language
856 cse: true, // Czech sign language
857 dsl: true, // Danish sign language
858 fsl: true, // French sign language
859 gsg: true, // German sign language
860 pks: true, // Pakistan sign language
861 jsl: true, // Japanese sign language
862 sfs: true, // South African sign language
863 swl: true, // Swedish sign language
864 rsl: true, // Russian sign language: true
865
866 epo: true, // Esperanto
867 tlh: true, // Klingon
868 jbo: true, // Lojban
869 avk: true // Kotava
1d94c154 870 }
9d3ef9fe
C
871
872 // Only add ISO639-1 languages and some sign languages (ISO639-3)
873 iso639
874 .filter(l => {
4fdeef81 875 return (l.iso6391 !== undefined && l.type === 'living') ||
a1587156 876 additionalLanguages[l.iso6393] === true
9d3ef9fe 877 })
a1587156 878 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
9d3ef9fe 879
db6d617d 880 // Override Occitan label
a1587156
C
881 languages['oc'] = 'Occitan'
882 languages['el'] = 'Greek'
db6d617d 883
9d3ef9fe
C
884 return languages
885}