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