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 = 240
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
31 // Sortable columns per schema
32 const SORTABLE_COLUMNS = {
33 USERS: [ 'id', 'username', 'createdAt' ],
34 ACCOUNTS: [ 'createdAt' ],
35 JOBS: [ 'createdAt' ],
36 VIDEO_ABUSES: [ 'id', 'createdAt' ],
37 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
38 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
39 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
40 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
41 FOLLOWERS: [ 'createdAt' ],
42 FOLLOWING: [ 'createdAt' ],
44 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ]
47 const OAUTH_LIFETIME = {
48 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
49 REFRESH_TOKEN: 1209600 // 2 weeks
52 const ROUTE_CACHE_LIFETIME = {
55 NODEINFO: '10 minutes',
57 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
61 // ---------------------------------------------------------------------------
63 // Number of points we add/remove after a successful/bad request
64 const ACTOR_FOLLOW_SCORE = {
71 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
76 const REMOTE_SCHEME = {
81 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
82 'activitypub-http-broadcast': 5,
83 'activitypub-http-unicast': 5,
84 'activitypub-http-fetcher': 5,
85 'activitypub-follow': 5,
86 'video-file-import': 1,
90 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
91 'activitypub-http-broadcast': 1,
92 'activitypub-http-unicast': 5,
93 'activitypub-http-fetcher': 1,
94 'activitypub-follow': 3,
95 'video-file-import': 1,
99 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
100 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
101 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
102 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
105 let SCHEDULER_INTERVALS_MS = {
106 badActorFollow: 60000 * 60, // 1 hour
107 removeOldJobs: 60000 * 60, // 1 hour
108 updateVideos: 60000 // 1 minute
111 // ---------------------------------------------------------------------------
114 CUSTOM_FILE: getLocalConfigFilePath(),
116 PORT: config.get<number>('listen.port'),
117 HOSTNAME: config.get<string>('listen.hostname')
120 DBNAME: 'peertube' + config.get<string>('database.suffix'),
121 HOSTNAME: config.get<string>('database.hostname'),
122 PORT: config.get<number>('database.port'),
123 USERNAME: config.get<string>('database.username'),
124 PASSWORD: config.get<string>('database.password'),
126 MAX: config.get<number>('database.pool.max')
130 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
131 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
132 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
133 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
134 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
137 HOSTNAME: config.get<string>('smtp.hostname'),
138 PORT: config.get<number>('smtp.port'),
139 USERNAME: config.get<string>('smtp.username'),
140 PASSWORD: config.get<string>('smtp.password'),
141 TLS: config.get<boolean>('smtp.tls'),
142 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
143 CA_FILE: config.get<string>('smtp.ca_file'),
144 FROM_ADDRESS: config.get<string>('smtp.from_address')
147 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
148 LOG_DIR: buildPath(config.get<string>('storage.logs')),
149 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
150 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
151 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
152 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
153 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
154 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
157 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
158 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
159 HOSTNAME: config.get<string>('webserver.hostname'),
160 PORT: config.get<number>('webserver.port'),
164 TRUST_PROXY: config.get<string[]>('trust_proxy'),
166 LEVEL: config.get<string>('log.level')
169 get EMAIL () { return config.get<string>('admin.email') }
172 get ENABLED () { return config.get<boolean>('signup.enabled') },
173 get LIMIT () { return config.get<number>('signup.limit') },
176 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
177 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
182 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
185 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
186 get THREADS () { return config.get<number>('transcoding.threads') },
188 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
189 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
190 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
191 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
192 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
197 get SIZE () { return config.get<number>('cache.previews.size') }
200 get SIZE () { return config.get<number>('cache.captions.size') }
204 get NAME () { return config.get<string>('instance.name') },
205 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
206 get DESCRIPTION () { return config.get<string>('instance.description') },
207 get TERMS () { return config.get<string>('instance.terms') },
208 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
209 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
211 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
212 get CSS () { return config.get<string>('instance.customizations.css') }
214 get ROBOTS () { return config.get<string>('instance.robots') }
218 get USERNAME () { return config.get<string>('services.twitter.username') },
219 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
224 // ---------------------------------------------------------------------------
226 const CONSTRAINTS_FIELDS = {
228 NAME: { min: 3, max: 120 }, // Length
229 DESCRIPTION: { min: 3, max: 250 }, // Length
230 USERNAME: { min: 3, max: 20 }, // Length
231 PASSWORD: { min: 6, max: 255 }, // Length
232 VIDEO_QUOTA: { min: -1 }
235 REASON: { min: 2, max: 300 } // Length
238 NAME: { min: 3, max: 120 }, // Length
239 DESCRIPTION: { min: 3, max: 500 }, // Length
240 SUPPORT: { min: 3, max: 500 }, // Length
241 URL: { min: 3, max: 2000 } // Length
245 EXTNAME: [ '.vtt', '.srt' ],
247 max: 2 * 1024 * 1024 // 2MB
252 NAME: { min: 3, max: 120 }, // Length
253 LANGUAGE: { min: 1, max: 10 }, // Length
254 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
255 DESCRIPTION: { min: 3, max: 10000 }, // Length
256 SUPPORT: { min: 3, max: 500 }, // Length
258 EXTNAME: [ '.jpg', '.jpeg' ],
260 max: 2 * 1024 * 1024 // 2MB
263 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
264 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
265 DURATION: { min: 1 }, // Number
266 TAGS: { min: 0, max: 5 }, // Number of total tags
267 TAG: { min: 2, max: 30 }, // Length
268 THUMBNAIL: { min: 2, max: 30 },
269 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
272 DISLIKES: { min: 0 },
273 FILE_SIZE: { min: 10 },
274 URL: { min: 3, max: 2000 } // Length
277 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
278 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
279 URL: { min: 3, max: 2000 }, // Length
281 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
283 max: 2 * 1024 * 1024 // 2MB
291 TEXT: { min: 1, max: 3000 }, // Length
292 URL: { min: 3, max: 2000 } // Length
295 URL: { min: 3, max: 2000 } // Length
299 const RATES_LIMIT = {
301 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
302 MAX: 15 // 15 attempts
306 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
307 const VIDEO_TRANSCODING_FPS = {
311 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
314 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
319 const VIDEO_CATEGORIES = {
334 15: 'Science & Technology',
340 // See https://creativecommons.org/licenses/?lang=en
341 const VIDEO_LICENCES = {
343 2: 'Attribution - Share Alike',
344 3: 'Attribution - No Derivatives',
345 4: 'Attribution - Non Commercial',
346 5: 'Attribution - Non Commercial - Share Alike',
347 6: 'Attribution - Non Commercial - No Derivatives',
348 7: 'Public Domain Dedication'
351 const VIDEO_LANGUAGES = buildLanguages()
353 const VIDEO_PRIVACIES = {
354 [VideoPrivacy.PUBLIC]: 'Public',
355 [VideoPrivacy.UNLISTED]: 'Unlisted',
356 [VideoPrivacy.PRIVATE]: 'Private'
359 const VIDEO_STATES = {
360 [VideoState.PUBLISHED]: 'Published',
361 [VideoState.TO_TRANSCODE]: 'To transcode'
364 const VIDEO_MIMETYPE_EXT = {
365 'video/webm': '.webm',
369 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
371 const IMAGE_MIMETYPE_EXT = {
377 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
379 'application/x-subrip': '.srt'
382 // ---------------------------------------------------------------------------
384 const SERVER_ACTOR_NAME = 'peertube'
386 const ACTIVITY_PUB = {
387 POTENTIAL_ACCEPT_HEADERS: [
388 'application/activity+json',
389 'application/ld+json',
390 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
392 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
393 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
394 COLLECTION_ITEMS_PER_PAGE: 10,
395 FETCH_PAGE_LIMIT: 100,
397 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
398 TORRENT: [ 'application/x-bittorrent' ],
399 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
401 MAX_RECURSION_COMMENTS: 100,
402 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
405 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
408 APPLICATION: 'Application'
411 // ---------------------------------------------------------------------------
413 const PRIVATE_RSA_KEY_SIZE = 2048
415 // Password encryption
416 const BCRYPT_SALT_SIZE = 10
418 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
420 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
421 DO_NOT_LIST: 'do_not_list',
426 // ---------------------------------------------------------------------------
428 // Express static paths (router)
429 const STATIC_PATHS = {
430 PREVIEWS: '/static/previews/',
431 THUMBNAILS: '/static/thumbnails/',
432 TORRENTS: '/static/torrents/',
433 WEBSEED: '/static/webseed/',
434 AVATARS: '/static/avatars/',
435 VIDEO_CAPTIONS: '/static/video-captions/'
437 const STATIC_DOWNLOAD_PATHS = {
438 TORRENTS: '/download/torrents/',
439 VIDEOS: '/download/videos/'
443 let STATIC_MAX_AGE = '2h'
445 // Videos thumbnail size
446 const THUMBNAILS_SIZE = {
450 const PREVIEWS_SIZE = {
454 const AVATARS_SIZE = {
464 // Sub folders of cache directory
467 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
468 MAX_AGE: 1000 * 3600 * 3 // 3 hours
471 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
472 MAX_AGE: 1000 * 3600 * 3 // 3 hours
476 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
478 // ---------------------------------------------------------------------------
480 const CUSTOM_HTML_TAG_COMMENTS = {
481 TITLE: '<!-- title tag -->',
482 DESCRIPTION: '<!-- description tag -->',
483 CUSTOM_CSS: '<!-- custom css tag -->',
484 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
487 // ---------------------------------------------------------------------------
493 // ---------------------------------------------------------------------------
495 const TRACKER_RATE_LIMITS = {
496 INTERVAL: 60000 * 5, // 5 minutes
497 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
498 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
501 // ---------------------------------------------------------------------------
503 // Special constants for a test instance
504 if (isTestInstance() === true) {
505 ACTOR_FOLLOW_SCORE.BASE = 20
507 REMOTE_SCHEME.HTTP = 'http'
508 REMOTE_SCHEME.WS = 'ws'
512 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
513 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
515 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
517 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
518 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
519 SCHEDULER_INTERVALS_MS.updateVideos = 5000
521 VIDEO_VIEW_LIFETIME = 1000 // 1 second
523 JOB_ATTEMPTS['email'] = 1
525 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
528 updateWebserverConfig()
530 // ---------------------------------------------------------------------------
534 VIDEO_CAPTIONS_MIMETYPE_EXT,
545 LAST_MIGRATION_VERSION,
547 CUSTOM_HTML_TAG_COMMENTS,
548 BROADCAST_CONCURRENCY,
555 PRIVATE_RSA_KEY_SIZE,
556 ROUTE_CACHE_LIFETIME,
563 ACTIVITY_PUB_ACTOR_TYPES,
572 VIDEO_TRANSCODING_FPS,
575 USER_PASSWORD_RESET_LIFETIME,
577 SCHEDULER_INTERVALS_MS,
578 STATIC_DOWNLOAD_PATHS,
581 JOB_COMPLETED_LIFETIME,
586 // ---------------------------------------------------------------------------
588 function getLocalConfigFilePath () {
589 const configSources = config.util.getConfigSources()
590 if (configSources.length === 0) throw new Error('Invalid config source.')
592 let filename = 'local'
593 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
594 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
596 return join(dirname(configSources[ 0 ].name), filename + '.json')
599 function updateWebserverConfig () {
600 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
601 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
604 function buildLanguages () {
605 const iso639 = require('iso-639-3')
607 const languages: { [ id: string ]: string } = {}
609 const additionalLanguages = {
610 'sgn': true, // Sign languages (macro language)
611 'ase': true, // American sign language
612 'sdl': true, // Arabian sign language
613 'bfi': true, // British sign language
614 'bzs': true, // Brazilian sign language
615 'csl': true, // Chinese sign language
616 'cse': true, // Czech sign language
617 'dsl': true, // Danish sign language
618 'fsl': true, // French sign language
619 'gsg': true, // German sign language
620 'pks': true, // Pakistan sign language
621 'jsl': true, // Japanese sign language
622 'sfs': true, // South African sign language
623 'swl': true, // Swedish sign language
624 'rsl': true, // Russian sign language: true
626 'epo': true, // Esperanto
627 'tlh': true, // Klingon
628 'jbo': true, // Lojban
629 'avk': true // Kotava
632 // Only add ISO639-1 languages and some sign languages (ISO639-3)
635 return (l.iso6391 !== null && l.type === 'living') ||
636 additionalLanguages[l.iso6393] === true
638 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
643 export function reloadConfig () {
645 function directory () {
646 if (process.env.NODE_CONFIG_DIR) {
647 return process.env.NODE_CONFIG_DIR
650 return join(root(), 'config')
654 for (const fileName in require.cache) {
655 if (-1 === fileName.indexOf(directory())) {
659 delete require.cache[fileName]
662 delete require.cache[require.resolve('config')]
667 config = require('config')
669 updateWebserverConfig()