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