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