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