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