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_IMPORTS: [ 'createdAt' ],
41 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
42 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
43 FOLLOWERS: [ 'createdAt' ],
44 FOLLOWING: [ 'createdAt' ],
46 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ]
49 const OAUTH_LIFETIME = {
50 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
51 REFRESH_TOKEN: 1209600 // 2 weeks
54 const ROUTE_CACHE_LIFETIME = {
57 NODEINFO: '10 minutes',
59 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
63 // ---------------------------------------------------------------------------
65 // Number of points we add/remove after a successful/bad request
66 const ACTOR_FOLLOW_SCORE = {
73 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
78 const REMOTE_SCHEME = {
83 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
84 'activitypub-http-broadcast': 5,
85 'activitypub-http-unicast': 5,
86 'activitypub-http-fetcher': 5,
87 'activitypub-follow': 5,
88 'video-file-import': 1,
93 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
94 'activitypub-http-broadcast': 1,
95 'activitypub-http-unicast': 5,
96 'activitypub-http-fetcher': 1,
97 'activitypub-follow': 3,
98 'video-file-import': 1,
103 const JOB_TTL: { [ id in JobType ]: number } = {
104 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
105 'activitypub-http-unicast': 60000 * 10, // 10 minutes
106 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
107 'activitypub-follow': 60000 * 10, // 10 minutes
108 'video-file-import': 1000 * 3600, // 1 hour
109 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
110 'video-import': 1000 * 3600 * 5, // 5 hours
111 'email': 60000 * 10 // 10 minutes
113 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
114 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
115 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
118 let SCHEDULER_INTERVALS_MS = {
119 badActorFollow: 60000 * 60, // 1 hour
120 removeOldJobs: 60000 * 60, // 1 hour
121 updateVideos: 60000, // 1 minute
122 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
125 // ---------------------------------------------------------------------------
128 CUSTOM_FILE: getLocalConfigFilePath(),
130 PORT: config.get<number>('listen.port'),
131 HOSTNAME: config.get<string>('listen.hostname')
134 DBNAME: 'peertube' + config.get<string>('database.suffix'),
135 HOSTNAME: config.get<string>('database.hostname'),
136 PORT: config.get<number>('database.port'),
137 USERNAME: config.get<string>('database.username'),
138 PASSWORD: config.get<string>('database.password'),
140 MAX: config.get<number>('database.pool.max')
144 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
145 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
146 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
147 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
148 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
151 HOSTNAME: config.get<string>('smtp.hostname'),
152 PORT: config.get<number>('smtp.port'),
153 USERNAME: config.get<string>('smtp.username'),
154 PASSWORD: config.get<string>('smtp.password'),
155 TLS: config.get<boolean>('smtp.tls'),
156 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
157 CA_FILE: config.get<string>('smtp.ca_file'),
158 FROM_ADDRESS: config.get<string>('smtp.from_address')
161 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
162 LOG_DIR: buildPath(config.get<string>('storage.logs')),
163 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
164 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
165 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
166 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
167 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
168 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
171 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
172 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
173 HOSTNAME: config.get<string>('webserver.hostname'),
174 PORT: config.get<number>('webserver.port'),
178 TRUST_PROXY: config.get<string[]>('trust_proxy'),
180 LEVEL: config.get<string>('log.level')
183 get EMAIL () { return config.get<string>('admin.email') }
186 get ENABLED () { return config.get<boolean>('signup.enabled') },
187 get LIMIT () { return config.get<number>('signup.limit') },
190 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
191 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
196 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
199 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
200 get THREADS () { return config.get<number>('transcoding.threads') },
202 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
203 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
204 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
205 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
206 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
211 get SIZE () { return config.get<number>('cache.previews.size') }
214 get SIZE () { return config.get<number>('cache.captions.size') }
218 get NAME () { return config.get<string>('instance.name') },
219 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
220 get DESCRIPTION () { return config.get<string>('instance.description') },
221 get TERMS () { return config.get<string>('instance.terms') },
222 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
223 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
225 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
226 get CSS () { return config.get<string>('instance.customizations.css') }
228 get ROBOTS () { return config.get<string>('instance.robots') }
232 get USERNAME () { return config.get<string>('services.twitter.username') },
233 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
238 // ---------------------------------------------------------------------------
240 const CONSTRAINTS_FIELDS = {
242 NAME: { min: 3, max: 120 }, // Length
243 DESCRIPTION: { min: 3, max: 250 }, // Length
244 USERNAME: { min: 3, max: 20 }, // Length
245 PASSWORD: { min: 6, max: 255 }, // Length
246 VIDEO_QUOTA: { min: -1 }
249 REASON: { min: 2, max: 300 } // Length
252 NAME: { min: 3, max: 120 }, // Length
253 DESCRIPTION: { min: 3, max: 500 }, // Length
254 SUPPORT: { min: 3, max: 500 }, // Length
255 URL: { min: 3, max: 2000 } // Length
259 EXTNAME: [ '.vtt', '.srt' ],
261 max: 2 * 1024 * 1024 // 2MB
266 URL: { min: 3, max: 2000 } // Length
269 NAME: { min: 3, max: 120 }, // Length
270 LANGUAGE: { min: 1, max: 10 }, // Length
271 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
272 DESCRIPTION: { min: 3, max: 10000 }, // Length
273 SUPPORT: { min: 3, max: 500 }, // Length
275 EXTNAME: [ '.jpg', '.jpeg' ],
277 max: 2 * 1024 * 1024 // 2MB
280 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
281 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
282 DURATION: { min: 0 }, // Number
283 TAGS: { min: 0, max: 5 }, // Number of total tags
284 TAG: { min: 2, max: 30 }, // Length
285 THUMBNAIL: { min: 2, max: 30 },
286 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
289 DISLIKES: { min: 0 },
290 FILE_SIZE: { min: 10 },
291 URL: { min: 3, max: 2000 } // Length
294 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
295 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
296 URL: { min: 3, max: 2000 }, // Length
298 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
300 max: 2 * 1024 * 1024 // 2MB
308 TEXT: { min: 1, max: 3000 }, // Length
309 URL: { min: 3, max: 2000 } // Length
312 URL: { min: 3, max: 2000 } // Length
316 const RATES_LIMIT = {
318 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
319 MAX: 15 // 15 attempts
323 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
324 const VIDEO_TRANSCODING_FPS = {
328 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
331 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
336 const FFMPEG_NICE: { [ id: string ]: number } = {
337 THUMBNAIL: 2, // 2 just for don't blocking servers
341 const VIDEO_CATEGORIES = {
356 15: 'Science & Technology',
362 // See https://creativecommons.org/licenses/?lang=en
363 const VIDEO_LICENCES = {
365 2: 'Attribution - Share Alike',
366 3: 'Attribution - No Derivatives',
367 4: 'Attribution - Non Commercial',
368 5: 'Attribution - Non Commercial - Share Alike',
369 6: 'Attribution - Non Commercial - No Derivatives',
370 7: 'Public Domain Dedication'
373 const VIDEO_LANGUAGES = buildLanguages()
375 const VIDEO_PRIVACIES = {
376 [VideoPrivacy.PUBLIC]: 'Public',
377 [VideoPrivacy.UNLISTED]: 'Unlisted',
378 [VideoPrivacy.PRIVATE]: 'Private'
381 const VIDEO_STATES = {
382 [VideoState.PUBLISHED]: 'Published',
383 [VideoState.TO_TRANSCODE]: 'To transcode',
384 [VideoState.TO_IMPORT]: 'To import'
387 const VIDEO_IMPORT_STATES = {
388 [VideoImportState.FAILED]: 'Failed',
389 [VideoImportState.PENDING]: 'Pending',
390 [VideoImportState.SUCCESS]: 'Success'
393 const VIDEO_MIMETYPE_EXT = {
394 'video/webm': '.webm',
398 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
400 const IMAGE_MIMETYPE_EXT = {
406 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
408 'application/x-subrip': '.srt'
411 // ---------------------------------------------------------------------------
413 const SERVER_ACTOR_NAME = 'peertube'
415 const ACTIVITY_PUB = {
416 POTENTIAL_ACCEPT_HEADERS: [
417 'application/activity+json',
418 'application/ld+json',
419 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
421 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
422 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
423 COLLECTION_ITEMS_PER_PAGE: 10,
424 FETCH_PAGE_LIMIT: 100,
426 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
427 TORRENT: [ 'application/x-bittorrent' ],
428 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
430 MAX_RECURSION_COMMENTS: 100,
431 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
434 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
437 APPLICATION: 'Application'
440 // ---------------------------------------------------------------------------
442 const PRIVATE_RSA_KEY_SIZE = 2048
444 // Password encryption
445 const BCRYPT_SALT_SIZE = 10
447 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
449 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
450 DO_NOT_LIST: 'do_not_list',
455 // ---------------------------------------------------------------------------
457 // Express static paths (router)
458 const STATIC_PATHS = {
459 PREVIEWS: '/static/previews/',
460 THUMBNAILS: '/static/thumbnails/',
461 TORRENTS: '/static/torrents/',
462 WEBSEED: '/static/webseed/',
463 AVATARS: '/static/avatars/',
464 VIDEO_CAPTIONS: '/static/video-captions/'
466 const STATIC_DOWNLOAD_PATHS = {
467 TORRENTS: '/download/torrents/',
468 VIDEOS: '/download/videos/'
472 let STATIC_MAX_AGE = '2h'
474 // Videos thumbnail size
475 const THUMBNAILS_SIZE = {
479 const PREVIEWS_SIZE = {
483 const AVATARS_SIZE = {
493 // Sub folders of cache directory
496 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
497 MAX_AGE: 1000 * 3600 * 3 // 3 hours
500 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
501 MAX_AGE: 1000 * 3600 * 3 // 3 hours
505 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
507 // ---------------------------------------------------------------------------
509 const CUSTOM_HTML_TAG_COMMENTS = {
510 TITLE: '<!-- title tag -->',
511 DESCRIPTION: '<!-- description tag -->',
512 CUSTOM_CSS: '<!-- custom css tag -->',
513 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
516 // ---------------------------------------------------------------------------
522 // ---------------------------------------------------------------------------
524 const TRACKER_RATE_LIMITS = {
525 INTERVAL: 60000 * 5, // 5 minutes
526 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
527 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
530 // ---------------------------------------------------------------------------
532 // Special constants for a test instance
533 if (isTestInstance() === true) {
534 ACTOR_FOLLOW_SCORE.BASE = 20
536 REMOTE_SCHEME.HTTP = 'http'
537 REMOTE_SCHEME.WS = 'ws'
541 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
542 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
544 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
546 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
547 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
548 SCHEDULER_INTERVALS_MS.updateVideos = 5000
550 VIDEO_VIEW_LIFETIME = 1000 // 1 second
552 JOB_ATTEMPTS['email'] = 1
554 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
557 updateWebserverConfig()
559 // ---------------------------------------------------------------------------
563 VIDEO_CAPTIONS_MIMETYPE_EXT,
574 LAST_MIGRATION_VERSION,
576 CUSTOM_HTML_TAG_COMMENTS,
577 BROADCAST_CONCURRENCY,
584 PRIVATE_RSA_KEY_SIZE,
585 ROUTE_CACHE_LIFETIME,
593 ACTIVITY_PUB_ACTOR_TYPES,
602 VIDEO_TRANSCODING_FPS,
605 USER_PASSWORD_RESET_LIFETIME,
607 SCHEDULER_INTERVALS_MS,
608 STATIC_DOWNLOAD_PATHS,
611 JOB_COMPLETED_LIFETIME,
617 // ---------------------------------------------------------------------------
619 function getLocalConfigFilePath () {
620 const configSources = config.util.getConfigSources()
621 if (configSources.length === 0) throw new Error('Invalid config source.')
623 let filename = 'local'
624 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
625 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
627 return join(dirname(configSources[ 0 ].name), filename + '.json')
630 function updateWebserverConfig () {
631 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
632 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
635 function buildLanguages () {
636 const iso639 = require('iso-639-3')
638 const languages: { [ id: string ]: string } = {}
640 const additionalLanguages = {
641 'sgn': true, // Sign languages (macro language)
642 'ase': true, // American sign language
643 'sdl': true, // Arabian sign language
644 'bfi': true, // British sign language
645 'bzs': true, // Brazilian sign language
646 'csl': true, // Chinese sign language
647 'cse': true, // Czech sign language
648 'dsl': true, // Danish sign language
649 'fsl': true, // French sign language
650 'gsg': true, // German sign language
651 'pks': true, // Pakistan sign language
652 'jsl': true, // Japanese sign language
653 'sfs': true, // South African sign language
654 'swl': true, // Swedish sign language
655 'rsl': true, // Russian sign language: true
657 'epo': true, // Esperanto
658 'tlh': true, // Klingon
659 'jbo': true, // Lojban
660 'avk': true // Kotava
663 // Only add ISO639-1 languages and some sign languages (ISO639-3)
666 return (l.iso6391 !== null && l.type === 'living') ||
667 additionalLanguages[l.iso6393] === true
669 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
674 export function reloadConfig () {
676 function directory () {
677 if (process.env.NODE_CONFIG_DIR) {
678 return process.env.NODE_CONFIG_DIR
681 return join(root(), 'config')
685 for (const fileName in require.cache) {
686 if (-1 === fileName.indexOf(directory())) {
690 delete require.cache[fileName]
693 delete require.cache[require.resolve('config')]
698 config = require('config')
700 updateWebserverConfig()