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