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