]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Put config redundancy strategies in "strategies" subkey
[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'
6b616860 6import { VideoAbuseState, VideoImportState, VideoPrivacy } from '../../shared/models/videos'
e02643f3 7// Do not use barrels, remain constants as independent as possible
fd206f0b 8import { buildPath, isTestInstance, 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
c48e82b5 19const LAST_MIGRATION_VERSION = 270
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
122 'video-import': 1000 * 3600 * 5, // 5 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
225a89c2 136
60650c77 137// 1 hour
2baea0c7
C
138let SCHEDULER_INTERVALS_MS = {
139 badActorFollow: 60000 * 60, // 1 hour
bbe0f064 140 removeOldJobs: 60000 * 60, // 1 hour
ce32426b 141 updateVideos: 60000, // 1 minute
c48e82b5
C
142 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
143 videosRedundancy: 60000 * 2 // 2 hours
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
C
215 VIDEOS: {
216 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
217 }
c48e82b5 218 },
4793c343 219 ADMIN: {
fd206f0b 220 get EMAIL () { return config.get<string>('admin.email') }
e22528ac
C
221 },
222 SIGNUP: {
fd206f0b 223 get ENABLED () { return config.get<boolean>('signup.enabled') },
ff2c1fe8 224 get LIMIT () { return config.get<number>('signup.limit') },
d9eaee39 225 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
ff2c1fe8
RK
226 FILTERS: {
227 CIDR: {
228 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
229 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
230 }
231 }
b0f9f39e
C
232 },
233 USER: {
bee0abff
FA
234 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
235 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
227d02fe
C
236 },
237 TRANSCODING: {
fd206f0b
C
238 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
239 get THREADS () { return config.get<number>('transcoding.threads') },
40298b02 240 RESOLUTIONS: {
fd206f0b
C
241 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
242 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
243 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
244 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
245 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
40298b02 246 }
f981dae8 247 },
5d08a6a7
C
248 IMPORT: {
249 VIDEOS: {
250 HTTP: {
251 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
a84b8fa5
C
252 },
253 TORRENT: {
254 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
5d08a6a7
C
255 }
256 }
257 },
f981dae8
C
258 CACHE: {
259 PREVIEWS: {
fd206f0b 260 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
261 },
262 VIDEO_CAPTIONS: {
263 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 264 }
66b16caf
C
265 },
266 INSTANCE: {
267 get NAME () { return config.get<string>('instance.name') },
2e3a0215 268 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 269 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 270 get TERMS () { return config.get<string>('instance.terms') },
901637bb 271 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 272 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
273 CUSTOMIZATIONS: {
274 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
275 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37 276 },
5447516b
AH
277 get ROBOTS () { return config.get<string>('instance.robots') },
278 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
279 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
8be1afa1
C
280 },
281 SERVICES: {
282 TWITTER: {
283 get USERNAME () { return config.get<string>('services.twitter.username') },
284 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
285 }
e861452f
C
286 }
287}
e861452f 288
9f6bae3a
C
289// ---------------------------------------------------------------------------
290
e4c55619
C
291const CONSTRAINTS_FIELDS = {
292 USERS: {
ed56ad11
C
293 NAME: { min: 3, max: 120 }, // Length
294 DESCRIPTION: { min: 3, max: 250 }, // Length
e4c55619 295 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e 296 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 297 VIDEO_QUOTA: { min: -1 },
bee0abff 298 VIDEO_QUOTA_DAILY: { min: -1 },
eacb25c4 299 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 300 },
55fa55a9 301 VIDEO_ABUSES: {
268eebed
C
302 REASON: { min: 2, max: 300 }, // Length
303 MODERATION_COMMENT: { min: 2, max: 300 } // Length
55fa55a9 304 },
26b7305a
C
305 VIDEO_BLACKLIST: {
306 REASON: { min: 2, max: 300 } // Length
307 },
72c7248b 308 VIDEO_CHANNELS: {
a265f7f3 309 NAME: { min: 3, max: 120 }, // Length
a10fc78b
C
310 DESCRIPTION: { min: 3, max: 500 }, // Length
311 SUPPORT: { min: 3, max: 500 }, // Length
e34c85e5 312 URL: { min: 3, max: 2000 } // Length
72c7248b 313 },
40e87e9e
C
314 VIDEO_CAPTIONS: {
315 CAPTION_FILE: {
f4001cf4 316 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
317 FILE_SIZE: {
318 max: 2 * 1024 * 1024 // 2MB
319 }
320 }
321 },
fbad87b0 322 VIDEO_IMPORTS: {
ce33919c
C
323 URL: { min: 3, max: 2000 }, // Length
324 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
325 TORRENT_FILE: {
326 EXTNAME: [ '.torrent' ],
327 FILE_SIZE: {
328 max: 1024 * 200 // 200 KB
329 }
330 }
fbad87b0 331 },
c48e82b5
C
332 VIDEOS_REDUNDANCY: {
333 URL: { min: 3, max: 2000 } // Length
334 },
e4c55619 335 VIDEOS: {
a265f7f3 336 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 337 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 338 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 339 DESCRIPTION: { min: 3, max: 10000 }, // Length
a10fc78b 340 SUPPORT: { min: 3, max: 500 }, // Length
ac81d1a0
C
341 IMAGE: {
342 EXTNAME: [ '.jpg', '.jpeg' ],
343 FILE_SIZE: {
344 max: 2 * 1024 * 1024 // 2MB
345 }
346 },
feb4bdfd 347 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 348 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 349 DURATION: { min: 0 }, // Number
a265f7f3
C
350 TAGS: { min: 0, max: 5 }, // Number of total tags
351 TAG: { min: 2, max: 30 }, // Length
e4c55619 352 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
353 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
354 VIEWS: { min: 0 },
355 LIKES: { min: 0 },
93e1258c 356 DISLIKES: { min: 0 },
c60774b0 357 FILE_SIZE: { min: 10 },
e34c85e5
C
358 URL: { min: 3, max: 2000 } // Length
359 },
01de67b9 360 ACTORS: {
e34c85e5
C
361 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
362 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
363 URL: { min: 3, max: 2000 }, // Length
364 AVATAR: {
01de67b9
C
365 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
366 FILE_SIZE: {
367 max: 2 * 1024 * 1024 // 2MB
368 }
c5911fd3 369 }
e4c87ec2
C
370 },
371 VIDEO_EVENTS: {
372 COUNT: { min: 0 }
6d852470 373 },
bf1f6508 374 VIDEO_COMMENTS: {
b32b7827 375 TEXT: { min: 1, max: 3000 }, // Length
6d852470 376 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
377 },
378 VIDEO_SHARE: {
379 URL: { min: 3, max: 2000 } // Length
e4c55619
C
380 }
381}
382
490b595a
C
383const RATES_LIMIT = {
384 LOGIN: {
385 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 386 MAX: 15 // 15 attempts
288fe385
C
387 },
388 ASK_SEND_EMAIL: {
389 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
390 MAX: 3 // 3 attempts
490b595a
C
391 }
392}
393
b5c0e955 394let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a7977280
C
395const VIDEO_TRANSCODING_FPS = {
396 MIN: 10,
3a6f351b
C
397 AVERAGE: 30,
398 MAX: 60,
399 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 400}
b5c0e955 401
ee9e7b61 402const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
403 LIKE: 'like',
404 DISLIKE: 'dislike'
405}
406
80bc88c1
J
407const FFMPEG_NICE: { [ id: string ]: number } = {
408 THUMBNAIL: 2, // 2 just for don't blocking servers
409 TRANSCODING: 15
410}
411
6e07c3de
C
412const VIDEO_CATEGORIES = {
413 1: 'Music',
414 2: 'Films',
415 3: 'Vehicles',
416 4: 'Art',
417 5: 'Sports',
418 6: 'Travels',
419 7: 'Gaming',
420 8: 'People',
421 9: 'Comedy',
422 10: 'Entertainment',
423 11: 'News',
40298b02 424 12: 'How To',
6e07c3de
C
425 13: 'Education',
426 14: 'Activism',
427 15: 'Science & Technology',
428 16: 'Animals',
429 17: 'Kids',
430 18: 'Food'
431}
432
6f0c39e2
C
433// See https://creativecommons.org/licenses/?lang=en
434const VIDEO_LICENCES = {
435 1: 'Attribution',
436 2: 'Attribution - Share Alike',
437 3: 'Attribution - No Derivatives',
438 4: 'Attribution - Non Commercial',
439 5: 'Attribution - Non Commercial - Share Alike',
440 6: 'Attribution - Non Commercial - No Derivatives',
441 7: 'Public Domain Dedication'
442}
443
9d3ef9fe 444const VIDEO_LANGUAGES = buildLanguages()
3092476e 445
fd45e8f4
C
446const VIDEO_PRIVACIES = {
447 [VideoPrivacy.PUBLIC]: 'Public',
448 [VideoPrivacy.UNLISTED]: 'Unlisted',
449 [VideoPrivacy.PRIVATE]: 'Private'
450}
451
2186386c
C
452const VIDEO_STATES = {
453 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
454 [VideoState.TO_TRANSCODE]: 'To transcode',
455 [VideoState.TO_IMPORT]: 'To import'
456}
457
458const VIDEO_IMPORT_STATES = {
459 [VideoImportState.FAILED]: 'Failed',
460 [VideoImportState.PENDING]: 'Pending',
461 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
462}
463
268eebed
C
464const VIDEO_ABUSE_STATES = {
465 [VideoAbuseState.PENDING]: 'Pending',
466 [VideoAbuseState.REJECTED]: 'Rejected',
467 [VideoAbuseState.ACCEPTED]: 'Accepted'
468}
469
0d0e8dd0 470const VIDEO_MIMETYPE_EXT = {
efc32059
C
471 'video/webm': '.webm',
472 'video/ogg': '.ogv',
473 'video/mp4': '.mp4'
0d0e8dd0 474}
28be8916 475const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 476
ac81d1a0 477const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
478 'image/png': '.png',
479 'image/jpg': '.jpg',
480 'image/jpeg': '.jpg'
481}
482
40e87e9e 483const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
484 'text/vtt': '.vtt',
485 'application/x-subrip': '.srt'
40e87e9e
C
486}
487
990b6a0b
C
488const TORRENT_MIMETYPE_EXT = {
489 'application/x-bittorrent': '.torrent'
490}
491
9f6bae3a
C
492// ---------------------------------------------------------------------------
493
2d3741d6
C
494const OVERVIEWS = {
495 VIDEOS: {
1a471091 496 SAMPLE_THRESHOLD: 6,
2d3741d6
C
497 SAMPLES_COUNT: 2
498 }
499}
500
501// ---------------------------------------------------------------------------
502
50d6de9c 503const SERVER_ACTOR_NAME = 'peertube'
350e31d6 504
e4f97bab 505const ACTIVITY_PUB = {
1b5b10d1
C
506 POTENTIAL_ACCEPT_HEADERS: [
507 'application/activity+json',
9a8cbd82
C
508 'application/ld+json',
509 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 510 ],
1b5b10d1 511 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 512 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 513 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 514 FETCH_PAGE_LIMIT: 100,
20494f12 515 URL_MIME_TYPES: {
f05a1c30 516 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
517 TORRENT: [ 'application/x-bittorrent' ],
518 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 519 },
2ccaeeb3 520 MAX_RECURSION_COMMENTS: 100,
1297eb5d
C
521 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
522 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
523}
524
50d6de9c
C
525const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
526 GROUP: 'Group',
527 PERSON: 'Person',
528 APPLICATION: 'Application'
529}
530
9f6bae3a
C
531// ---------------------------------------------------------------------------
532
e4f97bab 533const PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 534
9f6bae3a
C
535// Password encryption
536const BCRYPT_SALT_SIZE = 10
a877d5ac 537
ecb4e35f
C
538const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
539
d9eaee39
JM
540const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
541
0883b324
C
542const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
543 DO_NOT_LIST: 'do_not_list',
544 BLUR: 'blur',
545 DISPLAY: 'display'
546}
547
bdfbd4f1
C
548// ---------------------------------------------------------------------------
549
052937db
C
550// Express static paths (router)
551const STATIC_PATHS = {
f285faa0
C
552 PREVIEWS: '/static/previews/',
553 THUMBNAILS: '/static/thumbnails/',
052937db 554 TORRENTS: '/static/torrents/',
c5911fd3 555 WEBSEED: '/static/webseed/',
40e87e9e
C
556 AVATARS: '/static/avatars/',
557 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 558}
02756fbd
C
559const STATIC_DOWNLOAD_PATHS = {
560 TORRENTS: '/download/torrents/',
561 VIDEOS: '/download/videos/'
562}
052937db 563
dc009132 564// Cache control
57a81ff6 565let STATIC_MAX_AGE = '2h'
dc009132 566
cbe2f7c3 567// Videos thumbnail size
d8755eed
C
568const THUMBNAILS_SIZE = {
569 width: 200,
570 height: 110
571}
572const PREVIEWS_SIZE = {
164174a6
C
573 width: 560,
574 height: 315
575}
e8e12200
C
576const AVATARS_SIZE = {
577 width: 120,
578 height: 120
579}
164174a6
C
580
581const EMBED_SIZE = {
582 width: 560,
583 height: 315
d8755eed 584}
cbe2f7c3 585
980246ea 586// Sub folders of cache directory
f981dae8 587const CACHE = {
f4001cf4
C
588 PREVIEWS: {
589 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
590 MAX_AGE: 1000 * 3600 * 3 // 3 hours
591 },
592 VIDEO_CAPTIONS: {
593 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
594 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
595 }
596}
597
7348b1fd
C
598const MEMOIZE_TTL = {
599 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
600}
601
c48e82b5
C
602const REDUNDANCY = {
603 VIDEOS: {
604 EXPIRES_AFTER_MS: 48 * 3600 * 1000, // 2 days
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
c48e82b5 654 SCHEDULER_INTERVALS_MS.videosRedundancy = 5000
6b616860 655 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 656
c48e82b5
C
657 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
658
b5c0e955 659 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
660
661 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
662
663 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
743164fe 664 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
c07b6041 665 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
9f10b292
C
666}
667
fd206f0b 668updateWebserverConfig()
225a89c2 669
9f10b292
C
670// ---------------------------------------------------------------------------
671
65fcc311 672export {
9f6bae3a 673 API_VERSION,
40e87e9e 674 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 675 AVATARS_SIZE,
4f491371 676 ACCEPT_HEADERS,
9f6bae3a 677 BCRYPT_SALT_SIZE,
9b67da3d 678 TRACKER_RATE_LIMITS,
f981dae8 679 CACHE,
9f6bae3a
C
680 CONFIG,
681 CONSTRAINTS_FIELDS,
164174a6 682 EMBED_SIZE,
c48e82b5 683 REDUNDANCY,
94a5ff8a
C
684 JOB_CONCURRENCY,
685 JOB_ATTEMPTS,
b769007f 686 LAST_MIGRATION_VERSION,
9f6bae3a 687 OAUTH_LIFETIME,
e032aec9 688 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 689 BROADCAST_CONCURRENCY,
1194e8b4 690 PAGINATION,
60650c77 691 ACTOR_FOLLOW_SCORE,
f285faa0
C
692 PREVIEWS_SIZE,
693 REMOTE_SCHEME,
7a7724e6 694 FOLLOW_STATES,
50d6de9c 695 SERVER_ACTOR_NAME,
e4f97bab 696 PRIVATE_RSA_KEY_SIZE,
fd4484f1 697 ROUTE_CACHE_LIFETIME,
9f6bae3a 698 SORTABLE_COLUMNS,
4195cd2b 699 FEEDS,
2b86fe72 700 JOB_TTL,
0883b324 701 NSFW_POLICY_TYPES,
990b6a0b 702 TORRENT_MIMETYPE_EXT,
dc009132 703 STATIC_MAX_AGE,
a6375e69 704 STATIC_PATHS,
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
3f6b6a56 754function buildVideosRedundancy (objs: VideosRedundancy[]): VideosRedundancy[] {
c48e82b5
C
755 if (!objs) return []
756
3f6b6a56 757 return objs.map(obj => Object.assign(obj, { size: bytes.parse(obj.size) }))
c48e82b5
C
758}
759
9d3ef9fe
C
760function buildLanguages () {
761 const iso639 = require('iso-639-3')
762
763 const languages: { [ id: string ]: string } = {}
764
1d94c154
C
765 const additionalLanguages = {
766 'sgn': true, // Sign languages (macro language)
767 'ase': true, // American sign language
768 'sdl': true, // Arabian sign language
769 'bfi': true, // British sign language
770 'bzs': true, // Brazilian sign language
771 'csl': true, // Chinese sign language
772 'cse': true, // Czech sign language
773 'dsl': true, // Danish sign language
774 'fsl': true, // French sign language
775 'gsg': true, // German sign language
776 'pks': true, // Pakistan sign language
777 'jsl': true, // Japanese sign language
778 'sfs': true, // South African sign language
779 'swl': true, // Swedish sign language
780 'rsl': true, // Russian sign language: true
781
782 'epo': true, // Esperanto
783 'tlh': true, // Klingon
784 'jbo': true, // Lojban
785 'avk': true // Kotava
786 }
9d3ef9fe
C
787
788 // Only add ISO639-1 languages and some sign languages (ISO639-3)
789 iso639
790 .filter(l => {
791 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 792 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
793 })
794 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
795
db6d617d
C
796 // Override Occitan label
797 languages['oc'] = 'Occitan'
798
9d3ef9fe
C
799 return languages
800}
801
fd206f0b
C
802export function reloadConfig () {
803
804 function directory () {
805 if (process.env.NODE_CONFIG_DIR) {
806 return process.env.NODE_CONFIG_DIR
807 }
808
809 return join(root(), 'config')
810 }
811
812 function purge () {
813 for (const fileName in require.cache) {
814 if (-1 === fileName.indexOf(directory())) {
815 continue
816 }
817
818 delete require.cache[fileName]
819 }
820
821 delete require.cache[require.resolve('config')]
822 }
823
824 purge()
825
826 config = require('config')
827
828 updateWebserverConfig()
829}