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