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'
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')
127 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
128 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
129 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
130 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
131 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
134 HOSTNAME: config.get<string>('smtp.hostname'),
135 PORT: config.get<number>('smtp.port'),
136 USERNAME: config.get<string>('smtp.username'),
137 PASSWORD: config.get<string>('smtp.password'),
138 TLS: config.get<boolean>('smtp.tls'),
139 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
140 CA_FILE: config.get<string>('smtp.ca_file'),
141 FROM_ADDRESS: config.get<string>('smtp.from_address')
144 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
145 LOG_DIR: buildPath(config.get<string>('storage.logs')),
146 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
147 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
148 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
149 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
150 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
151 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
154 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
155 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
156 HOSTNAME: config.get<string>('webserver.hostname'),
157 PORT: config.get<number>('webserver.port'),
161 TRUST_PROXY: config.get<string[]>('trust_proxy'),
163 LEVEL: config.get<string>('log.level')
166 get EMAIL () { return config.get<string>('admin.email') }
169 get ENABLED () { return config.get<boolean>('signup.enabled') },
170 get LIMIT () { return config.get<number>('signup.limit') },
173 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
174 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
179 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
182 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
183 get THREADS () { return config.get<number>('transcoding.threads') },
185 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
186 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
187 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
188 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
189 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
194 get SIZE () { return config.get<number>('cache.previews.size') }
197 get SIZE () { return config.get<number>('cache.captions.size') }
201 get NAME () { return config.get<string>('instance.name') },
202 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
203 get DESCRIPTION () { return config.get<string>('instance.description') },
204 get TERMS () { return config.get<string>('instance.terms') },
205 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
206 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
208 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
209 get CSS () { return config.get<string>('instance.customizations.css') }
211 get ROBOTS () { return config.get<string>('instance.robots') }
215 get USERNAME () { return config.get<string>('services.twitter.username') },
216 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
221 // ---------------------------------------------------------------------------
223 const CONSTRAINTS_FIELDS = {
225 NAME: { min: 3, max: 120 }, // Length
226 DESCRIPTION: { min: 3, max: 250 }, // Length
227 USERNAME: { min: 3, max: 20 }, // Length
228 PASSWORD: { min: 6, max: 255 }, // Length
229 VIDEO_QUOTA: { min: -1 }
232 REASON: { min: 2, max: 300 } // Length
235 NAME: { min: 3, max: 120 }, // Length
236 DESCRIPTION: { min: 3, max: 500 }, // Length
237 SUPPORT: { min: 3, max: 500 }, // Length
238 URL: { min: 3, max: 2000 } // Length
242 EXTNAME: [ '.vtt', '.srt' ],
244 max: 2 * 1024 * 1024 // 2MB
249 NAME: { min: 3, max: 120 }, // Length
250 LANGUAGE: { min: 1, max: 10 }, // Length
251 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
252 DESCRIPTION: { min: 3, max: 10000 }, // Length
253 SUPPORT: { min: 3, max: 500 }, // Length
255 EXTNAME: [ '.jpg', '.jpeg' ],
257 max: 2 * 1024 * 1024 // 2MB
260 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
261 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
262 DURATION: { min: 1 }, // Number
263 TAGS: { min: 0, max: 5 }, // Number of total tags
264 TAG: { min: 2, max: 30 }, // Length
265 THUMBNAIL: { min: 2, max: 30 },
266 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
269 DISLIKES: { min: 0 },
270 FILE_SIZE: { min: 10 },
271 URL: { min: 3, max: 2000 } // Length
274 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
275 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
276 URL: { min: 3, max: 2000 }, // Length
278 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
280 max: 2 * 1024 * 1024 // 2MB
288 TEXT: { min: 1, max: 3000 }, // Length
289 URL: { min: 3, max: 2000 } // Length
292 URL: { min: 3, max: 2000 } // Length
296 const RATES_LIMIT = {
298 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
299 MAX: 15 // 15 attempts
303 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
304 const VIDEO_TRANSCODING_FPS = {
308 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
311 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
316 const VIDEO_CATEGORIES = {
331 15: 'Science & Technology',
337 // See https://creativecommons.org/licenses/?lang=en
338 const VIDEO_LICENCES = {
340 2: 'Attribution - Share Alike',
341 3: 'Attribution - No Derivatives',
342 4: 'Attribution - Non Commercial',
343 5: 'Attribution - Non Commercial - Share Alike',
344 6: 'Attribution - Non Commercial - No Derivatives',
345 7: 'Public Domain Dedication'
348 const VIDEO_LANGUAGES = buildLanguages()
350 const VIDEO_PRIVACIES = {
351 [VideoPrivacy.PUBLIC]: 'Public',
352 [VideoPrivacy.UNLISTED]: 'Unlisted',
353 [VideoPrivacy.PRIVATE]: 'Private'
356 const VIDEO_STATES = {
357 [VideoState.PUBLISHED]: 'Published',
358 [VideoState.TO_TRANSCODE]: 'To transcode'
361 const VIDEO_MIMETYPE_EXT = {
362 'video/webm': '.webm',
366 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
368 const IMAGE_MIMETYPE_EXT = {
374 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
376 'application/x-subrip': '.srt'
379 // ---------------------------------------------------------------------------
381 const SERVER_ACTOR_NAME = 'peertube'
383 const ACTIVITY_PUB = {
384 POTENTIAL_ACCEPT_HEADERS: [
385 'application/activity+json',
386 'application/ld+json',
387 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
389 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
390 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
391 COLLECTION_ITEMS_PER_PAGE: 10,
392 FETCH_PAGE_LIMIT: 100,
394 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
395 TORRENT: [ 'application/x-bittorrent' ],
396 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
398 MAX_RECURSION_COMMENTS: 100,
399 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
402 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
405 APPLICATION: 'Application'
408 // ---------------------------------------------------------------------------
410 const PRIVATE_RSA_KEY_SIZE = 2048
412 // Password encryption
413 const BCRYPT_SALT_SIZE = 10
415 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
417 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
418 DO_NOT_LIST: 'do_not_list',
423 // ---------------------------------------------------------------------------
425 // Express static paths (router)
426 const STATIC_PATHS = {
427 PREVIEWS: '/static/previews/',
428 THUMBNAILS: '/static/thumbnails/',
429 TORRENTS: '/static/torrents/',
430 WEBSEED: '/static/webseed/',
431 AVATARS: '/static/avatars/',
432 VIDEO_CAPTIONS: '/static/video-captions/'
434 const STATIC_DOWNLOAD_PATHS = {
435 TORRENTS: '/download/torrents/',
436 VIDEOS: '/download/videos/'
440 let STATIC_MAX_AGE = '2h'
442 // Videos thumbnail size
443 const THUMBNAILS_SIZE = {
447 const PREVIEWS_SIZE = {
451 const AVATARS_SIZE = {
461 // Sub folders of cache directory
464 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
465 MAX_AGE: 1000 * 3600 * 3 // 3 hours
468 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
469 MAX_AGE: 1000 * 3600 * 3 // 3 hours
473 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
475 // ---------------------------------------------------------------------------
477 const CUSTOM_HTML_TAG_COMMENTS = {
478 TITLE: '<!-- title tag -->',
479 DESCRIPTION: '<!-- description tag -->',
480 CUSTOM_CSS: '<!-- custom css tag -->',
481 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
484 // ---------------------------------------------------------------------------
490 // ---------------------------------------------------------------------------
492 const TRACKER_RATE_LIMITS = {
493 INTERVAL: 60000 * 5, // 5 minutes
494 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
495 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
498 // ---------------------------------------------------------------------------
500 // Special constants for a test instance
501 if (isTestInstance() === true) {
502 ACTOR_FOLLOW_SCORE.BASE = 20
504 REMOTE_SCHEME.HTTP = 'http'
505 REMOTE_SCHEME.WS = 'ws'
509 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
510 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
512 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
514 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
515 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
516 SCHEDULER_INTERVALS_MS.updateVideos = 5000
518 VIDEO_VIEW_LIFETIME = 1000 // 1 second
520 JOB_ATTEMPTS['email'] = 1
522 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
525 updateWebserverConfig()
527 // ---------------------------------------------------------------------------
531 VIDEO_CAPTIONS_MIMETYPE_EXT,
542 LAST_MIGRATION_VERSION,
544 CUSTOM_HTML_TAG_COMMENTS,
545 BROADCAST_CONCURRENCY,
552 PRIVATE_RSA_KEY_SIZE,
553 ROUTE_CACHE_LIFETIME,
560 ACTIVITY_PUB_ACTOR_TYPES,
569 VIDEO_TRANSCODING_FPS,
572 USER_PASSWORD_RESET_LIFETIME,
574 SCHEDULER_INTERVALS_MS,
575 STATIC_DOWNLOAD_PATHS,
578 JOB_COMPLETED_LIFETIME,
583 // ---------------------------------------------------------------------------
585 function getLocalConfigFilePath () {
586 const configSources = config.util.getConfigSources()
587 if (configSources.length === 0) throw new Error('Invalid config source.')
589 let filename = 'local'
590 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
591 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
593 return join(dirname(configSources[ 0 ].name), filename + '.json')
596 function updateWebserverConfig () {
597 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
598 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
601 function buildLanguages () {
602 const iso639 = require('iso-639-3')
604 const languages: { [ id: string ]: string } = {}
606 const additionalLanguages = {
607 'sgn': true, // Sign languages (macro language)
608 'ase': true, // American sign language
609 'sdl': true, // Arabian sign language
610 'bfi': true, // British sign language
611 'bzs': true, // Brazilian sign language
612 'csl': true, // Chinese sign language
613 'cse': true, // Czech sign language
614 'dsl': true, // Danish sign language
615 'fsl': true, // French sign language
616 'gsg': true, // German sign language
617 'pks': true, // Pakistan sign language
618 'jsl': true, // Japanese sign language
619 'sfs': true, // South African sign language
620 'swl': true, // Swedish sign language
621 'rsl': true, // Russian sign language: true
623 'epo': true, // Esperanto
624 'tlh': true, // Klingon
625 'jbo': true, // Lojban
626 'avk': true // Kotava
629 // Only add ISO639-1 languages and some sign languages (ISO639-3)
632 return (l.iso6391 !== null && l.type === 'living') ||
633 additionalLanguages[l.iso6393] === true
635 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
640 export function reloadConfig () {
642 function directory () {
643 if (process.env.NODE_CONFIG_DIR) {
644 return process.env.NODE_CONFIG_DIR
647 return join(root(), 'config')
651 for (const fileName in require.cache) {
652 if (-1 === fileName.indexOf(directory())) {
656 delete require.cache[fileName]
659 delete require.cache[require.resolve('config')]
664 config = require('config')
666 updateWebserverConfig()