1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType, VideoState } from '../../shared/models'
4 import { ActivityPubActorType } from '../../shared/models/activitypub'
5 import { FollowState } from '../../shared/models/actors'
6 import { VideoPrivacy } from '../../shared/models/videos'
7 // Do not use barrels, remain constants as independent as possible
8 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
10 import { invert } from 'lodash'
12 // Use a variable to reload the configuration if we need
13 let config: IConfig = require('config')
15 // ---------------------------------------------------------------------------
17 const LAST_MIGRATION_VERSION = 235
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
24 // Number of results by default for the pagination
25 const PAGINATION_COUNT_DEFAULT = 15
27 // Sortable columns per schema
28 const SORTABLE_COLUMNS = {
29 USERS: [ 'id', 'username', 'createdAt' ],
30 ACCOUNTS: [ 'createdAt' ],
31 JOBS: [ 'createdAt' ],
32 VIDEO_ABUSES: [ 'id', 'createdAt' ],
33 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
34 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
35 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
36 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
37 FOLLOWERS: [ 'createdAt' ],
38 FOLLOWING: [ 'createdAt' ],
40 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ]
43 const OAUTH_LIFETIME = {
44 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
45 REFRESH_TOKEN: 1209600 // 2 weeks
48 const ROUTE_CACHE_LIFETIME = {
51 NODEINFO: '10 minutes',
53 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
57 // ---------------------------------------------------------------------------
59 // Number of points we add/remove after a successful/bad request
60 const ACTOR_FOLLOW_SCORE = {
67 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
72 const REMOTE_SCHEME = {
77 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
78 'activitypub-http-broadcast': 5,
79 'activitypub-http-unicast': 5,
80 'activitypub-http-fetcher': 5,
81 'activitypub-follow': 5,
82 'video-file-import': 1,
86 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
87 'activitypub-http-broadcast': 1,
88 'activitypub-http-unicast': 5,
89 'activitypub-http-fetcher': 1,
90 'activitypub-follow': 3,
91 'video-file-import': 1,
95 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
96 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
97 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
98 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
101 let SCHEDULER_INTERVALS_MS = {
102 badActorFollow: 60000 * 60, // 1 hour
103 removeOldJobs: 60000 * 60, // 1 hour
104 updateVideos: 60000 // 1 minute
107 // ---------------------------------------------------------------------------
110 CUSTOM_FILE: getLocalConfigFilePath(),
112 PORT: config.get<number>('listen.port'),
113 HOSTNAME: config.get<string>('listen.hostname')
116 DBNAME: 'peertube' + config.get<string>('database.suffix'),
117 HOSTNAME: config.get<string>('database.hostname'),
118 PORT: config.get<number>('database.port'),
119 USERNAME: config.get<string>('database.username'),
120 PASSWORD: config.get<string>('database.password')
123 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
124 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
125 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
126 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
127 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
130 HOSTNAME: config.get<string>('smtp.hostname'),
131 PORT: config.get<number>('smtp.port'),
132 USERNAME: config.get<string>('smtp.username'),
133 PASSWORD: config.get<string>('smtp.password'),
134 TLS: config.get<boolean>('smtp.tls'),
135 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
136 CA_FILE: config.get<string>('smtp.ca_file'),
137 FROM_ADDRESS: config.get<string>('smtp.from_address')
140 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
141 LOG_DIR: buildPath(config.get<string>('storage.logs')),
142 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
143 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
144 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
145 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
146 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
147 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
150 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
151 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
152 HOSTNAME: config.get<string>('webserver.hostname'),
153 PORT: config.get<number>('webserver.port'),
157 TRUST_PROXY: config.get<string[]>('trust_proxy'),
159 LEVEL: config.get<string>('log.level')
162 get EMAIL () { return config.get<string>('admin.email') }
165 get ENABLED () { return config.get<boolean>('signup.enabled') },
166 get LIMIT () { return config.get<number>('signup.limit') },
169 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
170 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
175 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
178 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
179 get THREADS () { return config.get<number>('transcoding.threads') },
181 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
182 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
183 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
184 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
185 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
190 get SIZE () { return config.get<number>('cache.previews.size') }
193 get SIZE () { return config.get<number>('cache.captions.size') }
197 get NAME () { return config.get<string>('instance.name') },
198 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
199 get DESCRIPTION () { return config.get<string>('instance.description') },
200 get TERMS () { return config.get<string>('instance.terms') },
201 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
202 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
204 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
205 get CSS () { return config.get<string>('instance.customizations.css') }
207 get ROBOTS () { return config.get<string>('instance.robots') }
211 get USERNAME () { return config.get<string>('services.twitter.username') },
212 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
217 // ---------------------------------------------------------------------------
219 const CONSTRAINTS_FIELDS = {
221 NAME: { min: 3, max: 120 }, // Length
222 DESCRIPTION: { min: 3, max: 250 }, // Length
223 USERNAME: { min: 3, max: 20 }, // Length
224 PASSWORD: { min: 6, max: 255 }, // Length
225 VIDEO_QUOTA: { min: -1 }
228 REASON: { min: 2, max: 300 } // Length
231 NAME: { min: 3, max: 120 }, // Length
232 DESCRIPTION: { min: 3, max: 500 }, // Length
233 SUPPORT: { min: 3, max: 500 }, // Length
234 URL: { min: 3, max: 2000 } // Length
238 EXTNAME: [ '.vtt', '.srt' ],
240 max: 2 * 1024 * 1024 // 2MB
245 NAME: { min: 3, max: 120 }, // Length
246 LANGUAGE: { min: 1, max: 10 }, // Length
247 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
248 DESCRIPTION: { min: 3, max: 10000 }, // Length
249 SUPPORT: { min: 3, max: 500 }, // Length
251 EXTNAME: [ '.jpg', '.jpeg' ],
253 max: 2 * 1024 * 1024 // 2MB
256 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
257 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
258 DURATION: { min: 1 }, // Number
259 TAGS: { min: 0, max: 5 }, // Number of total tags
260 TAG: { min: 2, max: 30 }, // Length
261 THUMBNAIL: { min: 2, max: 30 },
262 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
265 DISLIKES: { min: 0 },
266 FILE_SIZE: { min: 10 },
267 URL: { min: 3, max: 2000 } // Length
270 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
271 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
272 URL: { min: 3, max: 2000 }, // Length
274 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
276 max: 2 * 1024 * 1024 // 2MB
284 TEXT: { min: 1, max: 3000 }, // Length
285 URL: { min: 3, max: 2000 } // Length
288 URL: { min: 3, max: 2000 } // Length
292 const RATES_LIMIT = {
294 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
295 MAX: 15 // 15 attempts
299 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
300 const VIDEO_TRANSCODING_FPS = {
304 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
307 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
312 const VIDEO_CATEGORIES = {
327 15: 'Science & Technology',
333 // See https://creativecommons.org/licenses/?lang=en
334 const VIDEO_LICENCES = {
336 2: 'Attribution - Share Alike',
337 3: 'Attribution - No Derivatives',
338 4: 'Attribution - Non Commercial',
339 5: 'Attribution - Non Commercial - Share Alike',
340 6: 'Attribution - Non Commercial - No Derivatives',
341 7: 'Public Domain Dedication'
344 const VIDEO_LANGUAGES = buildLanguages()
346 const VIDEO_PRIVACIES = {
347 [VideoPrivacy.PUBLIC]: 'Public',
348 [VideoPrivacy.UNLISTED]: 'Unlisted',
349 [VideoPrivacy.PRIVATE]: 'Private'
352 const VIDEO_STATES = {
353 [VideoState.PUBLISHED]: 'Published',
354 [VideoState.TO_TRANSCODE]: 'To transcode'
357 const VIDEO_MIMETYPE_EXT = {
358 'video/webm': '.webm',
362 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
364 const IMAGE_MIMETYPE_EXT = {
370 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
372 'application/x-subrip': '.srt'
375 // ---------------------------------------------------------------------------
377 const SERVER_ACTOR_NAME = 'peertube'
379 const ACTIVITY_PUB = {
380 POTENTIAL_ACCEPT_HEADERS: [
381 'application/activity+json',
382 'application/ld+json',
383 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
385 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
386 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
387 COLLECTION_ITEMS_PER_PAGE: 10,
388 FETCH_PAGE_LIMIT: 100,
390 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
391 TORRENT: [ 'application/x-bittorrent' ],
392 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
394 MAX_RECURSION_COMMENTS: 100,
395 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
398 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
401 APPLICATION: 'Application'
404 // ---------------------------------------------------------------------------
406 const PRIVATE_RSA_KEY_SIZE = 2048
408 // Password encryption
409 const BCRYPT_SALT_SIZE = 10
411 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
413 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
414 DO_NOT_LIST: 'do_not_list',
419 // ---------------------------------------------------------------------------
421 // Express static paths (router)
422 const STATIC_PATHS = {
423 PREVIEWS: '/static/previews/',
424 THUMBNAILS: '/static/thumbnails/',
425 TORRENTS: '/static/torrents/',
426 WEBSEED: '/static/webseed/',
427 AVATARS: '/static/avatars/',
428 VIDEO_CAPTIONS: '/static/video-captions/'
430 const STATIC_DOWNLOAD_PATHS = {
431 TORRENTS: '/download/torrents/',
432 VIDEOS: '/download/videos/'
436 let STATIC_MAX_AGE = '2h'
438 // Videos thumbnail size
439 const THUMBNAILS_SIZE = {
443 const PREVIEWS_SIZE = {
447 const AVATARS_SIZE = {
457 // Sub folders of cache directory
460 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
461 MAX_AGE: 1000 * 3600 * 3 // 3 hours
464 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
465 MAX_AGE: 1000 * 3600 * 3 // 3 hours
469 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
471 // ---------------------------------------------------------------------------
473 const CUSTOM_HTML_TAG_COMMENTS = {
474 TITLE: '<!-- title tag -->',
475 DESCRIPTION: '<!-- description tag -->',
476 CUSTOM_CSS: '<!-- custom css tag -->',
477 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
480 // ---------------------------------------------------------------------------
486 // ---------------------------------------------------------------------------
488 const TRACKER_RATE_LIMITS = {
489 INTERVAL: 60000 * 5, // 5 minutes
490 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
491 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
494 // ---------------------------------------------------------------------------
496 // Special constants for a test instance
497 if (isTestInstance() === true) {
498 ACTOR_FOLLOW_SCORE.BASE = 20
500 REMOTE_SCHEME.HTTP = 'http'
501 REMOTE_SCHEME.WS = 'ws'
505 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
506 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
508 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
510 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
511 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
512 SCHEDULER_INTERVALS_MS.updateVideos = 5000
514 VIDEO_VIEW_LIFETIME = 1000 // 1 second
516 JOB_ATTEMPTS['email'] = 1
518 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
521 updateWebserverConfig()
523 // ---------------------------------------------------------------------------
527 VIDEO_CAPTIONS_MIMETYPE_EXT,
538 LAST_MIGRATION_VERSION,
540 CUSTOM_HTML_TAG_COMMENTS,
541 BROADCAST_CONCURRENCY,
542 PAGINATION_COUNT_DEFAULT,
548 PRIVATE_RSA_KEY_SIZE,
549 ROUTE_CACHE_LIFETIME,
556 ACTIVITY_PUB_ACTOR_TYPES,
565 VIDEO_TRANSCODING_FPS,
568 USER_PASSWORD_RESET_LIFETIME,
570 SCHEDULER_INTERVALS_MS,
571 STATIC_DOWNLOAD_PATHS,
574 JOB_COMPLETED_LIFETIME,
579 // ---------------------------------------------------------------------------
581 function getLocalConfigFilePath () {
582 const configSources = config.util.getConfigSources()
583 if (configSources.length === 0) throw new Error('Invalid config source.')
585 let filename = 'local'
586 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
587 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
589 return join(dirname(configSources[ 0 ].name), filename + '.json')
592 function updateWebserverConfig () {
593 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
594 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
597 function buildLanguages () {
598 const iso639 = require('iso-639-3')
600 const languages: { [ id: string ]: string } = {}
602 const additionalLanguages = {
603 'sgn': true, // Sign languages (macro language)
604 'ase': true, // American sign language
605 'sdl': true, // Arabian sign language
606 'bfi': true, // British sign language
607 'bzs': true, // Brazilian sign language
608 'csl': true, // Chinese sign language
609 'cse': true, // Czech sign language
610 'dsl': true, // Danish sign language
611 'fsl': true, // French sign language
612 'gsg': true, // German sign language
613 'pks': true, // Pakistan sign language
614 'jsl': true, // Japanese sign language
615 'sfs': true, // South African sign language
616 'swl': true, // Swedish sign language
617 'rsl': true, // Russian sign language: true
619 'epo': true, // Esperanto
620 'tlh': true, // Klingon
621 'jbo': true, // Lojban
622 'avk': true // Kotava
625 // Only add ISO639-1 languages and some sign languages (ISO639-3)
628 return (l.iso6391 !== null && l.type === 'living') ||
629 additionalLanguages[l.iso6393] === true
631 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
636 export function reloadConfig () {
638 function directory () {
639 if (process.env.NODE_CONFIG_DIR) {
640 return process.env.NODE_CONFIG_DIR
643 return join(root(), 'config')
647 for (const fileName in require.cache) {
648 if (-1 === fileName.indexOf(directory())) {
652 delete require.cache[fileName]
655 delete require.cache[require.resolve('config')]
660 config = require('config')
662 updateWebserverConfig()