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'
11 import { VideoImportState } from '../../shared/models/videos/video-import-state.enum'
13 // Use a variable to reload the configuration if we need
14 let config: IConfig = require('config')
16 // ---------------------------------------------------------------------------
18 const LAST_MIGRATION_VERSION = 240
20 // ---------------------------------------------------------------------------
23 const API_VERSION = 'v1'
32 // Sortable columns per schema
33 const SORTABLE_COLUMNS = {
34 USERS: [ 'id', 'username', 'createdAt' ],
35 ACCOUNTS: [ 'createdAt' ],
36 JOBS: [ 'createdAt' ],
37 VIDEO_ABUSES: [ 'id', 'createdAt' ],
38 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
39 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
40 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
41 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
42 FOLLOWERS: [ 'createdAt' ],
43 FOLLOWING: [ 'createdAt' ],
45 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ]
48 const OAUTH_LIFETIME = {
49 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
50 REFRESH_TOKEN: 1209600 // 2 weeks
53 const ROUTE_CACHE_LIFETIME = {
56 NODEINFO: '10 minutes',
58 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
62 // ---------------------------------------------------------------------------
64 // Number of points we add/remove after a successful/bad request
65 const ACTOR_FOLLOW_SCORE = {
72 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
77 const REMOTE_SCHEME = {
82 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
83 'activitypub-http-broadcast': 5,
84 'activitypub-http-unicast': 5,
85 'activitypub-http-fetcher': 5,
86 'activitypub-follow': 5,
87 'video-file-import': 1,
92 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
93 'activitypub-http-broadcast': 1,
94 'activitypub-http-unicast': 5,
95 'activitypub-http-fetcher': 1,
96 'activitypub-follow': 3,
97 'video-file-import': 1,
102 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
103 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
104 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
105 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
108 let SCHEDULER_INTERVALS_MS = {
109 badActorFollow: 60000 * 60, // 1 hour
110 removeOldJobs: 60000 * 60, // 1 hour
111 updateVideos: 60000, // 1 minute
112 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
115 // ---------------------------------------------------------------------------
118 CUSTOM_FILE: getLocalConfigFilePath(),
120 PORT: config.get<number>('listen.port'),
121 HOSTNAME: config.get<string>('listen.hostname')
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'),
128 PASSWORD: config.get<string>('database.password'),
130 MAX: config.get<number>('database.pool.max')
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
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'),
146 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
147 CA_FILE: config.get<string>('smtp.ca_file'),
148 FROM_ADDRESS: config.get<string>('smtp.from_address')
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')),
156 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
157 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
158 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
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'),
168 TRUST_PROXY: config.get<string[]>('trust_proxy'),
170 LEVEL: config.get<string>('log.level')
173 get EMAIL () { return config.get<string>('admin.email') }
176 get ENABLED () { return config.get<boolean>('signup.enabled') },
177 get LIMIT () { return config.get<number>('signup.limit') },
180 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
181 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
186 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
189 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
190 get THREADS () { return config.get<number>('transcoding.threads') },
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') }
201 get SIZE () { return config.get<number>('cache.previews.size') }
204 get SIZE () { return config.get<number>('cache.captions.size') }
208 get NAME () { return config.get<string>('instance.name') },
209 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
210 get DESCRIPTION () { return config.get<string>('instance.description') },
211 get TERMS () { return config.get<string>('instance.terms') },
212 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
213 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
215 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
216 get CSS () { return config.get<string>('instance.customizations.css') }
218 get ROBOTS () { return config.get<string>('instance.robots') }
222 get USERNAME () { return config.get<string>('services.twitter.username') },
223 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
228 // ---------------------------------------------------------------------------
230 const CONSTRAINTS_FIELDS = {
232 NAME: { min: 3, max: 120 }, // Length
233 DESCRIPTION: { min: 3, max: 250 }, // Length
234 USERNAME: { min: 3, max: 20 }, // Length
235 PASSWORD: { min: 6, max: 255 }, // Length
236 VIDEO_QUOTA: { min: -1 }
239 REASON: { min: 2, max: 300 } // Length
242 NAME: { min: 3, max: 120 }, // Length
243 DESCRIPTION: { min: 3, max: 500 }, // Length
244 SUPPORT: { min: 3, max: 500 }, // Length
245 URL: { min: 3, max: 2000 } // Length
249 EXTNAME: [ '.vtt', '.srt' ],
251 max: 2 * 1024 * 1024 // 2MB
256 URL: { min: 3, max: 2000 } // Length
259 NAME: { min: 3, max: 120 }, // Length
260 LANGUAGE: { min: 1, max: 10 }, // Length
261 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
262 DESCRIPTION: { min: 3, max: 10000 }, // Length
263 SUPPORT: { min: 3, max: 500 }, // Length
265 EXTNAME: [ '.jpg', '.jpeg' ],
267 max: 2 * 1024 * 1024 // 2MB
270 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
271 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
272 DURATION: { min: 0 }, // Number
273 TAGS: { min: 0, max: 5 }, // Number of total tags
274 TAG: { min: 2, max: 30 }, // Length
275 THUMBNAIL: { min: 2, max: 30 },
276 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
279 DISLIKES: { min: 0 },
280 FILE_SIZE: { min: 10 },
281 URL: { min: 3, max: 2000 } // Length
284 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
285 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
286 URL: { min: 3, max: 2000 }, // Length
288 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
290 max: 2 * 1024 * 1024 // 2MB
298 TEXT: { min: 1, max: 3000 }, // Length
299 URL: { min: 3, max: 2000 } // Length
302 URL: { min: 3, max: 2000 } // Length
306 const RATES_LIMIT = {
308 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
309 MAX: 15 // 15 attempts
313 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
314 const VIDEO_TRANSCODING_FPS = {
318 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
321 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
326 const FFMPEG_NICE: { [ id: string ]: number } = {
327 THUMBNAIL: 2, // 2 just for don't blocking servers
331 const VIDEO_CATEGORIES = {
346 15: 'Science & Technology',
352 // See https://creativecommons.org/licenses/?lang=en
353 const VIDEO_LICENCES = {
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'
363 const VIDEO_LANGUAGES = buildLanguages()
365 const VIDEO_PRIVACIES = {
366 [VideoPrivacy.PUBLIC]: 'Public',
367 [VideoPrivacy.UNLISTED]: 'Unlisted',
368 [VideoPrivacy.PRIVATE]: 'Private'
371 const VIDEO_STATES = {
372 [VideoState.PUBLISHED]: 'Published',
373 [VideoState.TO_TRANSCODE]: 'To transcode',
374 [VideoState.TO_IMPORT]: 'To import'
377 const VIDEO_IMPORT_STATES = {
378 [VideoImportState.FAILED]: 'Failed',
379 [VideoImportState.PENDING]: 'Pending',
380 [VideoImportState.SUCCESS]: 'Success'
383 const VIDEO_MIMETYPE_EXT = {
384 'video/webm': '.webm',
388 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
390 const IMAGE_MIMETYPE_EXT = {
396 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
398 'application/x-subrip': '.srt'
401 // ---------------------------------------------------------------------------
403 const SERVER_ACTOR_NAME = 'peertube'
405 const ACTIVITY_PUB = {
406 POTENTIAL_ACCEPT_HEADERS: [
407 'application/activity+json',
408 'application/ld+json',
409 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
411 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
412 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
413 COLLECTION_ITEMS_PER_PAGE: 10,
414 FETCH_PAGE_LIMIT: 100,
416 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
417 TORRENT: [ 'application/x-bittorrent' ],
418 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
420 MAX_RECURSION_COMMENTS: 100,
421 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
424 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
427 APPLICATION: 'Application'
430 // ---------------------------------------------------------------------------
432 const PRIVATE_RSA_KEY_SIZE = 2048
434 // Password encryption
435 const BCRYPT_SALT_SIZE = 10
437 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
439 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
440 DO_NOT_LIST: 'do_not_list',
445 // ---------------------------------------------------------------------------
447 // Express static paths (router)
448 const STATIC_PATHS = {
449 PREVIEWS: '/static/previews/',
450 THUMBNAILS: '/static/thumbnails/',
451 TORRENTS: '/static/torrents/',
452 WEBSEED: '/static/webseed/',
453 AVATARS: '/static/avatars/',
454 VIDEO_CAPTIONS: '/static/video-captions/'
456 const STATIC_DOWNLOAD_PATHS = {
457 TORRENTS: '/download/torrents/',
458 VIDEOS: '/download/videos/'
462 let STATIC_MAX_AGE = '2h'
464 // Videos thumbnail size
465 const THUMBNAILS_SIZE = {
469 const PREVIEWS_SIZE = {
473 const AVATARS_SIZE = {
483 // Sub folders of cache directory
486 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
487 MAX_AGE: 1000 * 3600 * 3 // 3 hours
490 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
491 MAX_AGE: 1000 * 3600 * 3 // 3 hours
495 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
497 // ---------------------------------------------------------------------------
499 const 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 -->'
506 // ---------------------------------------------------------------------------
512 // ---------------------------------------------------------------------------
514 const TRACKER_RATE_LIMITS = {
515 INTERVAL: 60000 * 5, // 5 minutes
516 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
517 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
520 // ---------------------------------------------------------------------------
522 // Special constants for a test instance
523 if (isTestInstance() === true) {
524 ACTOR_FOLLOW_SCORE.BASE = 20
526 REMOTE_SCHEME.HTTP = 'http'
527 REMOTE_SCHEME.WS = 'ws'
531 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
532 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
534 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
536 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
537 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
538 SCHEDULER_INTERVALS_MS.updateVideos = 5000
540 VIDEO_VIEW_LIFETIME = 1000 // 1 second
542 JOB_ATTEMPTS['email'] = 1
544 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
547 updateWebserverConfig()
549 // ---------------------------------------------------------------------------
553 VIDEO_CAPTIONS_MIMETYPE_EXT,
564 LAST_MIGRATION_VERSION,
566 CUSTOM_HTML_TAG_COMMENTS,
567 BROADCAST_CONCURRENCY,
574 PRIVATE_RSA_KEY_SIZE,
575 ROUTE_CACHE_LIFETIME,
582 ACTIVITY_PUB_ACTOR_TYPES,
591 VIDEO_TRANSCODING_FPS,
595 USER_PASSWORD_RESET_LIFETIME,
597 SCHEDULER_INTERVALS_MS,
598 STATIC_DOWNLOAD_PATHS,
601 JOB_COMPLETED_LIFETIME,
607 // ---------------------------------------------------------------------------
609 function getLocalConfigFilePath () {
610 const configSources = config.util.getConfigSources()
611 if (configSources.length === 0) throw new Error('Invalid config source.')
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}`
617 return join(dirname(configSources[ 0 ].name), filename + '.json')
620 function 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)
625 function buildLanguages () {
626 const iso639 = require('iso-639-3')
628 const languages: { [ id: string ]: string } = {}
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
647 'epo': true, // Esperanto
648 'tlh': true, // Klingon
649 'jbo': true, // Lojban
650 'avk': true // Kotava
653 // Only add ISO639-1 languages and some sign languages (ISO639-3)
656 return (l.iso6391 !== null && l.type === 'living') ||
657 additionalLanguages[l.iso6393] === true
659 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
664 export function reloadConfig () {
666 function directory () {
667 if (process.env.NODE_CONFIG_DIR) {
668 return process.env.NODE_CONFIG_DIR
671 return join(root(), 'config')
675 for (const fileName in require.cache) {
676 if (-1 === fileName.indexOf(directory())) {
680 delete require.cache[fileName]
683 delete require.cache[require.resolve('config')]
688 config = require('config')
690 updateWebserverConfig()