]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Set bitrate limits for transcoding (fixes #638) (#1135)
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
fd206f0b
C
1import { IConfig } from 'config'
2import { dirname, join } from 'path'
3f6b6a56 3import { JobType, VideoRateType, VideoState, VideosRedundancy } from '../../shared/models'
50d6de9c 4import { ActivityPubActorType } from '../../shared/models/activitypub'
225a89c2 5import { FollowState } from '../../shared/models/actors'
edb4ffc7 6import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
e02643f3 7// Do not use barrels, remain constants as independent as possible
f9f899b9 8import { buildPath, isTestInstance, parseDuration, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
0883b324 9import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
28be8916 10import { invert } from 'lodash'
6b616860 11import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
c48e82b5 12import * as bytes from 'bytes'
fd206f0b
C
13
14// Use a variable to reload the configuration if we need
15let config: IConfig = require('config')
ee9e7b61 16
9f6bae3a
C
17// ---------------------------------------------------------------------------
18
2e7cf5ae 19const LAST_MIGRATION_VERSION = 275
5804c0db
C
20
21// ---------------------------------------------------------------------------
22
9f6bae3a 23// API version
f0f5567b 24const API_VERSION = 'v1'
9f10b292 25
1194e8b4
C
26const PAGINATION = {
27 COUNT: {
28 DEFAULT: 15,
29 MAX: 100
30 }
31}
9f6bae3a 32
9f6bae3a
C
33// Sortable columns per schema
34const SORTABLE_COLUMNS = {
9c2c18f3 35 USERS: [ 'id', 'username', 'createdAt' ],
06a05d5f 36 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 37 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 38 JOBS: [ 'createdAt' ],
26b7305a 39 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
72c7248b 40 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
ed31c059 41 VIDEO_IMPORTS: [ 'createdAt' ],
bf1f6508 42 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
7a7724e6
C
43 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
44 FOLLOWERS: [ 'createdAt' ],
57c36b27
C
45 FOLLOWING: [ 'createdAt' ],
46
9a629c6e
C
47 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
48
49 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
f5b0af50 50 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
9f6bae3a 51}
9f10b292 52
2f372a86 53const OAUTH_LIFETIME = {
ff193d5e 54 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2f372a86
C
55 REFRESH_TOKEN: 1209600 // 2 weeks
56}
57
fd4484f1 58const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
59 FEEDS: '15 minutes',
60 ROBOTS: '2 hours',
5447516b 61 SECURITYTXT: '2 hours',
3f6d68d9 62 NODEINFO: '10 minutes',
aad0ec24 63 DNT_POLICY: '1 week',
2d3741d6
C
64 OVERVIEWS: {
65 VIDEOS: '1 hour'
66 },
fd4484f1 67 ACTIVITY_PUB: {
3f6d68d9 68 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
4b5384f6
C
69 },
70 STATS: '4 hours'
fd4484f1
C
71}
72
9f6bae3a 73// ---------------------------------------------------------------------------
26d7d31b 74
60650c77
C
75// Number of points we add/remove after a successful/bad request
76const ACTOR_FOLLOW_SCORE = {
225a89c2
C
77 PENALTY: -10,
78 BONUS: 10,
60650c77
C
79 BASE: 1000,
80 MAX: 10000
225a89c2
C
81}
82
83const FOLLOW_STATES: { [ id: string ]: FollowState } = {
84 PENDING: 'pending',
85 ACCEPTED: 'accepted'
86}
87
88const REMOTE_SCHEME = {
89 HTTP: 'https',
90 WS: 'wss'
91}
92
94a5ff8a
C
93const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
94 'activitypub-http-broadcast': 5,
95 'activitypub-http-unicast': 5,
96 'activitypub-http-fetcher': 5,
5350fd8e 97 'activitypub-follow': 5,
0138af92 98 'video-file-import': 1,
ecb4e35f 99 'video-file': 1,
fbad87b0 100 'video-import': 1,
6b616860
C
101 'email': 5,
102 'videos-views': 1
225a89c2 103}
94a5ff8a
C
104const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
105 'activitypub-http-broadcast': 1,
106 'activitypub-http-unicast': 5,
107 'activitypub-http-fetcher': 1,
5350fd8e 108 'activitypub-follow': 3,
0138af92 109 'video-file-import': 1,
ecb4e35f 110 'video-file': 1,
fbad87b0 111 'video-import': 1,
6b616860
C
112 'email': 5,
113 'videos-views': 1
225a89c2 114}
2b86fe72
C
115const JOB_TTL: { [ id in JobType ]: number } = {
116 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
117 'activitypub-http-unicast': 60000 * 10, // 10 minutes
118 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
119 'activitypub-follow': 60000 * 10, // 10 minutes
120 'video-file-import': 1000 * 3600, // 1 hour
121 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
cf9166cf 122 'video-import': 1000 * 3600 * 2, // hours
6b616860
C
123 'email': 60000 * 10, // 10 minutes
124 'videos-views': undefined // Unlimited
2b86fe72 125}
6b616860
C
126const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
127 'videos-views': {
128 cron: '1 * * * *' // At 1 minutes past the hour
129 }
130}
131
71e3dfda 132const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 133const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
71e3dfda 134const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
71e3dfda 135const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
cf9166cf 136const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
225a89c2 137
60650c77 138// 1 hour
2baea0c7
C
139let SCHEDULER_INTERVALS_MS = {
140 badActorFollow: 60000 * 60, // 1 hour
bbe0f064 141 removeOldJobs: 60000 * 60, // 1 hour
ce32426b 142 updateVideos: 60000, // 1 minute
f9f899b9 143 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
2baea0c7 144}
60650c77 145
225a89c2
C
146// ---------------------------------------------------------------------------
147
e861452f 148const CONFIG = {
fd206f0b 149 CUSTOM_FILE: getLocalConfigFilePath(),
d16b5172 150 LISTEN: {
cff8b272
PAT
151 PORT: config.get<number>('listen.port'),
152 HOSTNAME: config.get<string>('listen.hostname')
d16b5172 153 },
e861452f 154 DATABASE: {
65fcc311
C
155 DBNAME: 'peertube' + config.get<string>('database.suffix'),
156 HOSTNAME: config.get<string>('database.hostname'),
157 PORT: config.get<number>('database.port'),
158 USERNAME: config.get<string>('database.username'),
1c3386e8
RK
159 PASSWORD: config.get<string>('database.password'),
160 POOL: {
161 MAX: config.get<number>('database.pool.max')
162 }
e861452f 163 },
94a5ff8a 164 REDIS: {
19f7b248
RK
165 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
166 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
167 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
168 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
169 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
94a5ff8a 170 },
ecb4e35f
C
171 SMTP: {
172 HOSTNAME: config.get<string>('smtp.hostname'),
173 PORT: config.get<number>('smtp.port'),
174 USERNAME: config.get<string>('smtp.username'),
175 PASSWORD: config.get<string>('smtp.password'),
176 TLS: config.get<boolean>('smtp.tls'),
bebf2d89 177 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
ecb4e35f
C
178 CA_FILE: config.get<string>('smtp.ca_file'),
179 FROM_ADDRESS: config.get<string>('smtp.from_address')
180 },
e861452f 181 STORAGE: {
0b4204f9
C
182 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
183 LOG_DIR: buildPath(config.get<string>('storage.logs')),
184 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
185 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
186 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
40e87e9e 187 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
0b4204f9
C
188 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
189 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
e861452f
C
190 },
191 WEBSERVER: {
65fcc311
C
192 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
193 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
194 HOSTNAME: config.get<string>('webserver.hostname'),
195 PORT: config.get<number>('webserver.port'),
196 URL: '',
197 HOST: ''
4793c343 198 },
490b595a 199 TRUST_PROXY: config.get<string[]>('trust_proxy'),
23e27dd5
C
200 LOG: {
201 LEVEL: config.get<string>('log.level')
202 },
1297eb5d
C
203 SEARCH: {
204 REMOTE_URI: {
205 USERS: config.get<boolean>('search.remote_uri.users'),
206 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
207 }
208 },
9a629c6e
C
209 TRENDING: {
210 VIDEOS: {
211 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
212 }
213 },
c48e82b5 214 REDUNDANCY: {
d9bdd007 215 VIDEOS: {
f9f899b9 216 CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
d9bdd007
C
217 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
218 }
c48e82b5 219 },
4793c343 220 ADMIN: {
fd206f0b 221 get EMAIL () { return config.get<string>('admin.email') }
e22528ac
C
222 },
223 SIGNUP: {
fd206f0b 224 get ENABLED () { return config.get<boolean>('signup.enabled') },
ff2c1fe8 225 get LIMIT () { return config.get<number>('signup.limit') },
d9eaee39 226 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
ff2c1fe8
RK
227 FILTERS: {
228 CIDR: {
229 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
230 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
231 }
232 }
b0f9f39e
C
233 },
234 USER: {
bee0abff
FA
235 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
236 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
227d02fe
C
237 },
238 TRANSCODING: {
fd206f0b
C
239 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
240 get THREADS () { return config.get<number>('transcoding.threads') },
40298b02 241 RESOLUTIONS: {
fd206f0b
C
242 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
243 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
244 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
245 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
246 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
40298b02 247 }
f981dae8 248 },
5d08a6a7
C
249 IMPORT: {
250 VIDEOS: {
251 HTTP: {
252 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
a84b8fa5
C
253 },
254 TORRENT: {
255 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
5d08a6a7
C
256 }
257 }
258 },
f981dae8
C
259 CACHE: {
260 PREVIEWS: {
fd206f0b 261 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
262 },
263 VIDEO_CAPTIONS: {
264 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 265 }
66b16caf
C
266 },
267 INSTANCE: {
268 get NAME () { return config.get<string>('instance.name') },
2e3a0215 269 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 270 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 271 get TERMS () { return config.get<string>('instance.terms') },
901637bb 272 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 273 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
274 CUSTOMIZATIONS: {
275 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
276 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37 277 },
5447516b
AH
278 get ROBOTS () { return config.get<string>('instance.robots') },
279 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
280 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
8be1afa1
C
281 },
282 SERVICES: {
283 TWITTER: {
284 get USERNAME () { return config.get<string>('services.twitter.username') },
285 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
286 }
e861452f
C
287 }
288}
e861452f 289
9f6bae3a
C
290// ---------------------------------------------------------------------------
291
e4c55619
C
292const CONSTRAINTS_FIELDS = {
293 USERS: {
ed56ad11
C
294 NAME: { min: 3, max: 120 }, // Length
295 DESCRIPTION: { min: 3, max: 250 }, // Length
e4c55619 296 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e 297 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 298 VIDEO_QUOTA: { min: -1 },
bee0abff 299 VIDEO_QUOTA_DAILY: { min: -1 },
eacb25c4 300 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 301 },
55fa55a9 302 VIDEO_ABUSES: {
268eebed
C
303 REASON: { min: 2, max: 300 }, // Length
304 MODERATION_COMMENT: { min: 2, max: 300 } // Length
55fa55a9 305 },
26b7305a
C
306 VIDEO_BLACKLIST: {
307 REASON: { min: 2, max: 300 } // Length
308 },
72c7248b 309 VIDEO_CHANNELS: {
a265f7f3 310 NAME: { min: 3, max: 120 }, // Length
a10fc78b
C
311 DESCRIPTION: { min: 3, max: 500 }, // Length
312 SUPPORT: { min: 3, max: 500 }, // Length
e34c85e5 313 URL: { min: 3, max: 2000 } // Length
72c7248b 314 },
40e87e9e
C
315 VIDEO_CAPTIONS: {
316 CAPTION_FILE: {
f4001cf4 317 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
318 FILE_SIZE: {
319 max: 2 * 1024 * 1024 // 2MB
320 }
321 }
322 },
fbad87b0 323 VIDEO_IMPORTS: {
ce33919c
C
324 URL: { min: 3, max: 2000 }, // Length
325 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
326 TORRENT_FILE: {
327 EXTNAME: [ '.torrent' ],
328 FILE_SIZE: {
329 max: 1024 * 200 // 200 KB
330 }
331 }
fbad87b0 332 },
c48e82b5
C
333 VIDEOS_REDUNDANCY: {
334 URL: { min: 3, max: 2000 } // Length
335 },
e4c55619 336 VIDEOS: {
a265f7f3 337 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 338 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 339 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 340 DESCRIPTION: { min: 3, max: 10000 }, // Length
a10fc78b 341 SUPPORT: { min: 3, max: 500 }, // Length
ac81d1a0
C
342 IMAGE: {
343 EXTNAME: [ '.jpg', '.jpeg' ],
344 FILE_SIZE: {
345 max: 2 * 1024 * 1024 // 2MB
346 }
347 },
feb4bdfd 348 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 349 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 350 DURATION: { min: 0 }, // Number
a265f7f3
C
351 TAGS: { min: 0, max: 5 }, // Number of total tags
352 TAG: { min: 2, max: 30 }, // Length
e4c55619 353 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
354 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
355 VIEWS: { min: 0 },
356 LIKES: { min: 0 },
93e1258c 357 DISLIKES: { min: 0 },
c60774b0 358 FILE_SIZE: { min: 10 },
e34c85e5
C
359 URL: { min: 3, max: 2000 } // Length
360 },
01de67b9 361 ACTORS: {
e34c85e5
C
362 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
363 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
364 URL: { min: 3, max: 2000 }, // Length
365 AVATAR: {
01de67b9
C
366 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
367 FILE_SIZE: {
368 max: 2 * 1024 * 1024 // 2MB
369 }
c5911fd3 370 }
e4c87ec2
C
371 },
372 VIDEO_EVENTS: {
373 COUNT: { min: 0 }
6d852470 374 },
bf1f6508 375 VIDEO_COMMENTS: {
b32b7827 376 TEXT: { min: 1, max: 3000 }, // Length
6d852470 377 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
378 },
379 VIDEO_SHARE: {
380 URL: { min: 3, max: 2000 } // Length
e4c55619
C
381 }
382}
383
490b595a
C
384const RATES_LIMIT = {
385 LOGIN: {
386 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 387 MAX: 15 // 15 attempts
288fe385
C
388 },
389 ASK_SEND_EMAIL: {
390 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
391 MAX: 3 // 3 attempts
490b595a
C
392 }
393}
394
b5c0e955 395let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
edb4ffc7 396const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
a7977280 397 MIN: 10,
3a6f351b
C
398 AVERAGE: 30,
399 MAX: 60,
400 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 401}
b5c0e955 402
ee9e7b61 403const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
404 LIKE: 'like',
405 DISLIKE: 'dislike'
406}
407
80bc88c1
J
408const FFMPEG_NICE: { [ id: string ]: number } = {
409 THUMBNAIL: 2, // 2 just for don't blocking servers
410 TRANSCODING: 15
411}
412
6e07c3de
C
413const VIDEO_CATEGORIES = {
414 1: 'Music',
415 2: 'Films',
416 3: 'Vehicles',
417 4: 'Art',
418 5: 'Sports',
419 6: 'Travels',
420 7: 'Gaming',
421 8: 'People',
422 9: 'Comedy',
423 10: 'Entertainment',
424 11: 'News',
40298b02 425 12: 'How To',
6e07c3de
C
426 13: 'Education',
427 14: 'Activism',
428 15: 'Science & Technology',
429 16: 'Animals',
430 17: 'Kids',
431 18: 'Food'
432}
433
6f0c39e2
C
434// See https://creativecommons.org/licenses/?lang=en
435const VIDEO_LICENCES = {
436 1: 'Attribution',
437 2: 'Attribution - Share Alike',
438 3: 'Attribution - No Derivatives',
439 4: 'Attribution - Non Commercial',
440 5: 'Attribution - Non Commercial - Share Alike',
441 6: 'Attribution - Non Commercial - No Derivatives',
442 7: 'Public Domain Dedication'
443}
444
9d3ef9fe 445const VIDEO_LANGUAGES = buildLanguages()
3092476e 446
fd45e8f4
C
447const VIDEO_PRIVACIES = {
448 [VideoPrivacy.PUBLIC]: 'Public',
449 [VideoPrivacy.UNLISTED]: 'Unlisted',
450 [VideoPrivacy.PRIVATE]: 'Private'
451}
452
2186386c
C
453const VIDEO_STATES = {
454 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
455 [VideoState.TO_TRANSCODE]: 'To transcode',
456 [VideoState.TO_IMPORT]: 'To import'
457}
458
459const VIDEO_IMPORT_STATES = {
460 [VideoImportState.FAILED]: 'Failed',
461 [VideoImportState.PENDING]: 'Pending',
462 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
463}
464
268eebed
C
465const VIDEO_ABUSE_STATES = {
466 [VideoAbuseState.PENDING]: 'Pending',
467 [VideoAbuseState.REJECTED]: 'Rejected',
468 [VideoAbuseState.ACCEPTED]: 'Accepted'
469}
470
0d0e8dd0 471const VIDEO_MIMETYPE_EXT = {
efc32059
C
472 'video/webm': '.webm',
473 'video/ogg': '.ogv',
474 'video/mp4': '.mp4'
0d0e8dd0 475}
28be8916 476const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 477
ac81d1a0 478const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
479 'image/png': '.png',
480 'image/jpg': '.jpg',
481 'image/jpeg': '.jpg'
482}
483
40e87e9e 484const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
485 'text/vtt': '.vtt',
486 'application/x-subrip': '.srt'
40e87e9e
C
487}
488
990b6a0b
C
489const TORRENT_MIMETYPE_EXT = {
490 'application/x-bittorrent': '.torrent'
491}
492
9f6bae3a
C
493// ---------------------------------------------------------------------------
494
2d3741d6
C
495const OVERVIEWS = {
496 VIDEOS: {
1a471091 497 SAMPLE_THRESHOLD: 6,
2d3741d6
C
498 SAMPLES_COUNT: 2
499 }
500}
501
502// ---------------------------------------------------------------------------
503
50d6de9c 504const SERVER_ACTOR_NAME = 'peertube'
350e31d6 505
e4f97bab 506const ACTIVITY_PUB = {
1b5b10d1
C
507 POTENTIAL_ACCEPT_HEADERS: [
508 'application/activity+json',
9a8cbd82
C
509 'application/ld+json',
510 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 511 ],
1b5b10d1 512 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 513 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 514 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 515 FETCH_PAGE_LIMIT: 100,
20494f12 516 URL_MIME_TYPES: {
f05a1c30 517 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
518 TORRENT: [ 'application/x-bittorrent' ],
519 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 520 },
2ccaeeb3 521 MAX_RECURSION_COMMENTS: 100,
1297eb5d
C
522 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
523 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
524}
525
50d6de9c
C
526const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
527 GROUP: 'Group',
528 PERSON: 'Person',
529 APPLICATION: 'Application'
530}
531
9f6bae3a
C
532// ---------------------------------------------------------------------------
533
e4f97bab 534const PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 535
9f6bae3a
C
536// Password encryption
537const BCRYPT_SALT_SIZE = 10
a877d5ac 538
ecb4e35f
C
539const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
540
d9eaee39
JM
541const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
542
0883b324
C
543const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
544 DO_NOT_LIST: 'do_not_list',
545 BLUR: 'blur',
546 DISPLAY: 'display'
547}
548
bdfbd4f1
C
549// ---------------------------------------------------------------------------
550
052937db
C
551// Express static paths (router)
552const STATIC_PATHS = {
f285faa0
C
553 PREVIEWS: '/static/previews/',
554 THUMBNAILS: '/static/thumbnails/',
052937db 555 TORRENTS: '/static/torrents/',
c5911fd3 556 WEBSEED: '/static/webseed/',
40e87e9e
C
557 AVATARS: '/static/avatars/',
558 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 559}
02756fbd
C
560const STATIC_DOWNLOAD_PATHS = {
561 TORRENTS: '/download/torrents/',
562 VIDEOS: '/download/videos/'
563}
052937db 564
dc009132 565// Cache control
57a81ff6 566let STATIC_MAX_AGE = '2h'
dc009132 567
cbe2f7c3 568// Videos thumbnail size
d8755eed
C
569const THUMBNAILS_SIZE = {
570 width: 200,
571 height: 110
572}
573const PREVIEWS_SIZE = {
164174a6
C
574 width: 560,
575 height: 315
576}
e8e12200
C
577const AVATARS_SIZE = {
578 width: 120,
579 height: 120
580}
164174a6
C
581
582const EMBED_SIZE = {
583 width: 560,
584 height: 315
d8755eed 585}
cbe2f7c3 586
980246ea 587// Sub folders of cache directory
f981dae8 588const CACHE = {
f4001cf4
C
589 PREVIEWS: {
590 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
591 MAX_AGE: 1000 * 3600 * 3 // 3 hours
592 },
593 VIDEO_CAPTIONS: {
594 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
595 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
596 }
597}
598
7348b1fd
C
599const MEMOIZE_TTL = {
600 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
601}
602
c48e82b5
C
603const REDUNDANCY = {
604 VIDEOS: {
c48e82b5
C
605 RANDOMIZED_FACTOR: 5
606 }
607}
608
e12a0092 609const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 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 -->',
617 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
618}
709756b8
C
619
620// ---------------------------------------------------------------------------
621
4195cd2b 622const FEEDS = {
fd4484f1 623 COUNT: 20
4195cd2b
C
624}
625
626// ---------------------------------------------------------------------------
627
9b67da3d
C
628const TRACKER_RATE_LIMITS = {
629 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 630 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
631 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
632}
633
634// ---------------------------------------------------------------------------
635
9f10b292
C
636// Special constants for a test instance
637if (isTestInstance() === true) {
60650c77 638 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 639
f285faa0
C
640 REMOTE_SCHEME.HTTP = 'http'
641 REMOTE_SCHEME.WS = 'ws'
3cd0734f 642
65fcc311 643 STATIC_MAX_AGE = '0'
3cd0734f 644
c46edbc2 645 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 646 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 647 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 648
01de67b9 649 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 650
2baea0c7
C
651 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
652 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
653 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6b616860 654 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 655
c48e82b5
C
656 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
657
b5c0e955 658 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
659
660 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
661
662 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
743164fe 663 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
c07b6041 664 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
9f10b292
C
665}
666
fd206f0b 667updateWebserverConfig()
225a89c2 668
9f10b292
C
669// ---------------------------------------------------------------------------
670
65fcc311 671export {
9f6bae3a 672 API_VERSION,
40e87e9e 673 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 674 AVATARS_SIZE,
4f491371 675 ACCEPT_HEADERS,
9f6bae3a 676 BCRYPT_SALT_SIZE,
9b67da3d 677 TRACKER_RATE_LIMITS,
f981dae8 678 CACHE,
9f6bae3a
C
679 CONFIG,
680 CONSTRAINTS_FIELDS,
164174a6 681 EMBED_SIZE,
c48e82b5 682 REDUNDANCY,
94a5ff8a
C
683 JOB_CONCURRENCY,
684 JOB_ATTEMPTS,
b769007f 685 LAST_MIGRATION_VERSION,
9f6bae3a 686 OAUTH_LIFETIME,
e032aec9 687 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 688 BROADCAST_CONCURRENCY,
1194e8b4 689 PAGINATION,
60650c77 690 ACTOR_FOLLOW_SCORE,
f285faa0
C
691 PREVIEWS_SIZE,
692 REMOTE_SCHEME,
7a7724e6 693 FOLLOW_STATES,
50d6de9c 694 SERVER_ACTOR_NAME,
e4f97bab 695 PRIVATE_RSA_KEY_SIZE,
fd4484f1 696 ROUTE_CACHE_LIFETIME,
9f6bae3a 697 SORTABLE_COLUMNS,
4195cd2b 698 FEEDS,
2b86fe72 699 JOB_TTL,
0883b324 700 NSFW_POLICY_TYPES,
990b6a0b 701 TORRENT_MIMETYPE_EXT,
dc009132 702 STATIC_MAX_AGE,
a6375e69 703 STATIC_PATHS,
cf9166cf 704 VIDEO_IMPORT_TIMEOUT,
e4f97bab 705 ACTIVITY_PUB,
50d6de9c 706 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 707 THUMBNAILS_SIZE,
6e07c3de 708 VIDEO_CATEGORIES,
3092476e 709 VIDEO_LANGUAGES,
fd45e8f4 710 VIDEO_PRIVACIES,
6f0c39e2 711 VIDEO_LICENCES,
2186386c 712 VIDEO_STATES,
0d0e8dd0 713 VIDEO_RATE_TYPES,
c5911fd3 714 VIDEO_MIMETYPE_EXT,
a7977280 715 VIDEO_TRANSCODING_FPS,
80bc88c1 716 FFMPEG_NICE,
268eebed 717 VIDEO_ABUSE_STATES,
71e3dfda 718 JOB_REQUEST_TIMEOUT,
ecb4e35f 719 USER_PASSWORD_RESET_LIFETIME,
7348b1fd 720 MEMOIZE_TTL,
d9eaee39 721 USER_EMAIL_VERIFY_LIFETIME,
ac81d1a0 722 IMAGE_MIMETYPE_EXT,
2d3741d6 723 OVERVIEWS,
2baea0c7 724 SCHEDULER_INTERVALS_MS,
6b616860 725 REPEAT_JOBS,
02756fbd 726 STATIC_DOWNLOAD_PATHS,
490b595a 727 RATES_LIMIT,
28be8916 728 VIDEO_EXT_MIMETYPE,
f6eebcb3 729 CRAWL_REQUEST_CONCURRENCY,
b5c0e955 730 JOB_COMPLETED_LIFETIME,
fbad87b0 731 VIDEO_IMPORT_STATES,
7ce44a74
C
732 VIDEO_VIEW_LIFETIME,
733 buildLanguages
9f10b292 734}
fd206f0b
C
735
736// ---------------------------------------------------------------------------
737
738function getLocalConfigFilePath () {
739 const configSources = config.util.getConfigSources()
740 if (configSources.length === 0) throw new Error('Invalid config source.')
741
742 let filename = 'local'
743 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
744 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
745
746 return join(dirname(configSources[ 0 ].name), filename + '.json')
747}
748
749function updateWebserverConfig () {
750 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
751 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
752}
753
e5565833 754function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
c48e82b5
C
755 if (!objs) return []
756
e5565833
C
757 return objs.map(obj => {
758 return Object.assign(obj, {
759 minLifetime: parseDuration(obj.min_lifetime),
760 size: bytes.parse(obj.size),
761 minViews: obj.min_views
762 })
763 })
c48e82b5
C
764}
765
9d3ef9fe
C
766function buildLanguages () {
767 const iso639 = require('iso-639-3')
768
769 const languages: { [ id: string ]: string } = {}
770
1d94c154
C
771 const additionalLanguages = {
772 'sgn': true, // Sign languages (macro language)
773 'ase': true, // American sign language
774 'sdl': true, // Arabian sign language
775 'bfi': true, // British sign language
776 'bzs': true, // Brazilian sign language
777 'csl': true, // Chinese sign language
778 'cse': true, // Czech sign language
779 'dsl': true, // Danish sign language
780 'fsl': true, // French sign language
781 'gsg': true, // German sign language
782 'pks': true, // Pakistan sign language
783 'jsl': true, // Japanese sign language
784 'sfs': true, // South African sign language
785 'swl': true, // Swedish sign language
786 'rsl': true, // Russian sign language: true
787
788 'epo': true, // Esperanto
789 'tlh': true, // Klingon
790 'jbo': true, // Lojban
791 'avk': true // Kotava
792 }
9d3ef9fe
C
793
794 // Only add ISO639-1 languages and some sign languages (ISO639-3)
795 iso639
796 .filter(l => {
797 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 798 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
799 })
800 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
801
db6d617d
C
802 // Override Occitan label
803 languages['oc'] = 'Occitan'
804
9d3ef9fe
C
805 return languages
806}
807
fd206f0b
C
808export function reloadConfig () {
809
810 function directory () {
811 if (process.env.NODE_CONFIG_DIR) {
812 return process.env.NODE_CONFIG_DIR
813 }
814
815 return join(root(), 'config')
816 }
817
818 function purge () {
819 for (const fileName in require.cache) {
820 if (-1 === fileName.indexOf(directory())) {
821 continue
822 }
823
824 delete require.cache[fileName]
825 }
826
827 delete require.cache[require.resolve('config')]
828 }
829
830 purge()
831
832 config = require('config')
833
834 updateWebserverConfig()
835}