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