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, VideoAbuseState, VideoImportState } 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 = 255
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
31 // Sortable columns per schema
32 const SORTABLE_COLUMNS = {
33 USERS: [ 'id', 'username', 'createdAt' ],
34 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
35 ACCOUNTS: [ 'createdAt' ],
36 JOBS: [ 'createdAt' ],
37 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
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' ],
47 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
50 const OAUTH_LIFETIME = {
51 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
52 REFRESH_TOKEN: 1209600 // 2 weeks
55 const ROUTE_CACHE_LIFETIME = {
58 NODEINFO: '10 minutes',
61 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
65 // ---------------------------------------------------------------------------
67 // Number of points we add/remove after a successful/bad request
68 const ACTOR_FOLLOW_SCORE = {
75 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
80 const REMOTE_SCHEME = {
85 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
86 'activitypub-http-broadcast': 5,
87 'activitypub-http-unicast': 5,
88 'activitypub-http-fetcher': 5,
89 'activitypub-follow': 5,
90 'video-file-import': 1,
95 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
96 'activitypub-http-broadcast': 1,
97 'activitypub-http-unicast': 5,
98 'activitypub-http-fetcher': 1,
99 'activitypub-follow': 3,
100 'video-file-import': 1,
105 const JOB_TTL: { [ id in JobType ]: number } = {
106 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
107 'activitypub-http-unicast': 60000 * 10, // 10 minutes
108 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
109 'activitypub-follow': 60000 * 10, // 10 minutes
110 'video-file-import': 1000 * 3600, // 1 hour
111 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
112 'video-import': 1000 * 3600 * 5, // 5 hours
113 'email': 60000 * 10 // 10 minutes
115 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
116 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
117 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
118 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
121 let SCHEDULER_INTERVALS_MS = {
122 badActorFollow: 60000 * 60, // 1 hour
123 removeOldJobs: 60000 * 60, // 1 hour
124 updateVideos: 60000, // 1 minute
125 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
128 // ---------------------------------------------------------------------------
131 CUSTOM_FILE: getLocalConfigFilePath(),
133 PORT: config.get<number>('listen.port'),
134 HOSTNAME: config.get<string>('listen.hostname')
137 DBNAME: 'peertube' + config.get<string>('database.suffix'),
138 HOSTNAME: config.get<string>('database.hostname'),
139 PORT: config.get<number>('database.port'),
140 USERNAME: config.get<string>('database.username'),
141 PASSWORD: config.get<string>('database.password'),
143 MAX: config.get<number>('database.pool.max')
147 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
148 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
149 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
150 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
151 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
154 HOSTNAME: config.get<string>('smtp.hostname'),
155 PORT: config.get<number>('smtp.port'),
156 USERNAME: config.get<string>('smtp.username'),
157 PASSWORD: config.get<string>('smtp.password'),
158 TLS: config.get<boolean>('smtp.tls'),
159 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
160 CA_FILE: config.get<string>('smtp.ca_file'),
161 FROM_ADDRESS: config.get<string>('smtp.from_address')
164 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
165 LOG_DIR: buildPath(config.get<string>('storage.logs')),
166 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
167 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
168 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
169 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
170 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
171 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
174 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
175 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
176 HOSTNAME: config.get<string>('webserver.hostname'),
177 PORT: config.get<number>('webserver.port'),
181 TRUST_PROXY: config.get<string[]>('trust_proxy'),
183 LEVEL: config.get<string>('log.level')
187 USERS: config.get<boolean>('search.remote_uri.users'),
188 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
192 get EMAIL () { return config.get<string>('admin.email') }
195 get ENABLED () { return config.get<boolean>('signup.enabled') },
196 get LIMIT () { return config.get<number>('signup.limit') },
199 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
200 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
205 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
208 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
209 get THREADS () { return config.get<number>('transcoding.threads') },
211 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
212 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
213 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
214 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
215 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
221 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
224 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
230 get SIZE () { return config.get<number>('cache.previews.size') }
233 get SIZE () { return config.get<number>('cache.captions.size') }
237 get NAME () { return config.get<string>('instance.name') },
238 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
239 get DESCRIPTION () { return config.get<string>('instance.description') },
240 get TERMS () { return config.get<string>('instance.terms') },
241 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
242 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
244 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
245 get CSS () { return config.get<string>('instance.customizations.css') }
247 get ROBOTS () { return config.get<string>('instance.robots') }
251 get USERNAME () { return config.get<string>('services.twitter.username') },
252 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
257 // ---------------------------------------------------------------------------
259 const CONSTRAINTS_FIELDS = {
261 NAME: { min: 3, max: 120 }, // Length
262 DESCRIPTION: { min: 3, max: 250 }, // Length
263 USERNAME: { min: 3, max: 20 }, // Length
264 PASSWORD: { min: 6, max: 255 }, // Length
265 VIDEO_QUOTA: { min: -1 },
266 BLOCKED_REASON: { min: 3, max: 250 } // Length
269 REASON: { min: 2, max: 300 }, // Length
270 MODERATION_COMMENT: { min: 2, max: 300 } // Length
273 REASON: { min: 2, max: 300 } // Length
276 NAME: { min: 3, max: 120 }, // Length
277 DESCRIPTION: { min: 3, max: 500 }, // Length
278 SUPPORT: { min: 3, max: 500 }, // Length
279 URL: { min: 3, max: 2000 } // Length
283 EXTNAME: [ '.vtt', '.srt' ],
285 max: 2 * 1024 * 1024 // 2MB
290 URL: { min: 3, max: 2000 }, // Length
291 TORRENT_NAME: { min: 3, max: 255 }, // Length
293 EXTNAME: [ '.torrent' ],
295 max: 1024 * 200 // 200 KB
300 NAME: { min: 3, max: 120 }, // Length
301 LANGUAGE: { min: 1, max: 10 }, // Length
302 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
303 DESCRIPTION: { min: 3, max: 10000 }, // Length
304 SUPPORT: { min: 3, max: 500 }, // Length
306 EXTNAME: [ '.jpg', '.jpeg' ],
308 max: 2 * 1024 * 1024 // 2MB
311 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
312 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
313 DURATION: { min: 0 }, // Number
314 TAGS: { min: 0, max: 5 }, // Number of total tags
315 TAG: { min: 2, max: 30 }, // Length
316 THUMBNAIL: { min: 2, max: 30 },
317 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
320 DISLIKES: { min: 0 },
321 FILE_SIZE: { min: 10 },
322 URL: { min: 3, max: 2000 } // Length
325 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
326 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
327 URL: { min: 3, max: 2000 }, // Length
329 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
331 max: 2 * 1024 * 1024 // 2MB
339 TEXT: { min: 1, max: 3000 }, // Length
340 URL: { min: 3, max: 2000 } // Length
343 URL: { min: 3, max: 2000 } // Length
347 const RATES_LIMIT = {
349 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
350 MAX: 15 // 15 attempts
354 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
355 const VIDEO_TRANSCODING_FPS = {
359 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
362 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
367 const FFMPEG_NICE: { [ id: string ]: number } = {
368 THUMBNAIL: 2, // 2 just for don't blocking servers
372 const VIDEO_CATEGORIES = {
387 15: 'Science & Technology',
393 // See https://creativecommons.org/licenses/?lang=en
394 const VIDEO_LICENCES = {
396 2: 'Attribution - Share Alike',
397 3: 'Attribution - No Derivatives',
398 4: 'Attribution - Non Commercial',
399 5: 'Attribution - Non Commercial - Share Alike',
400 6: 'Attribution - Non Commercial - No Derivatives',
401 7: 'Public Domain Dedication'
404 const VIDEO_LANGUAGES = buildLanguages()
406 const VIDEO_PRIVACIES = {
407 [VideoPrivacy.PUBLIC]: 'Public',
408 [VideoPrivacy.UNLISTED]: 'Unlisted',
409 [VideoPrivacy.PRIVATE]: 'Private'
412 const VIDEO_STATES = {
413 [VideoState.PUBLISHED]: 'Published',
414 [VideoState.TO_TRANSCODE]: 'To transcode',
415 [VideoState.TO_IMPORT]: 'To import'
418 const VIDEO_IMPORT_STATES = {
419 [VideoImportState.FAILED]: 'Failed',
420 [VideoImportState.PENDING]: 'Pending',
421 [VideoImportState.SUCCESS]: 'Success'
424 const VIDEO_ABUSE_STATES = {
425 [VideoAbuseState.PENDING]: 'Pending',
426 [VideoAbuseState.REJECTED]: 'Rejected',
427 [VideoAbuseState.ACCEPTED]: 'Accepted'
430 const VIDEO_MIMETYPE_EXT = {
431 'video/webm': '.webm',
435 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
437 const IMAGE_MIMETYPE_EXT = {
443 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
445 'application/x-subrip': '.srt'
448 const TORRENT_MIMETYPE_EXT = {
449 'application/x-bittorrent': '.torrent'
452 // ---------------------------------------------------------------------------
454 const SERVER_ACTOR_NAME = 'peertube'
456 const ACTIVITY_PUB = {
457 POTENTIAL_ACCEPT_HEADERS: [
458 'application/activity+json',
459 'application/ld+json',
460 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
462 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
463 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
464 COLLECTION_ITEMS_PER_PAGE: 10,
465 FETCH_PAGE_LIMIT: 100,
467 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
468 TORRENT: [ 'application/x-bittorrent' ],
469 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
471 MAX_RECURSION_COMMENTS: 100,
472 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
473 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
476 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
479 APPLICATION: 'Application'
482 // ---------------------------------------------------------------------------
484 const PRIVATE_RSA_KEY_SIZE = 2048
486 // Password encryption
487 const BCRYPT_SALT_SIZE = 10
489 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
491 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
492 DO_NOT_LIST: 'do_not_list',
497 // ---------------------------------------------------------------------------
499 // Express static paths (router)
500 const STATIC_PATHS = {
501 PREVIEWS: '/static/previews/',
502 THUMBNAILS: '/static/thumbnails/',
503 TORRENTS: '/static/torrents/',
504 WEBSEED: '/static/webseed/',
505 AVATARS: '/static/avatars/',
506 VIDEO_CAPTIONS: '/static/video-captions/'
508 const STATIC_DOWNLOAD_PATHS = {
509 TORRENTS: '/download/torrents/',
510 VIDEOS: '/download/videos/'
514 let STATIC_MAX_AGE = '2h'
516 // Videos thumbnail size
517 const THUMBNAILS_SIZE = {
521 const PREVIEWS_SIZE = {
525 const AVATARS_SIZE = {
535 // Sub folders of cache directory
538 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
539 MAX_AGE: 1000 * 3600 * 3 // 3 hours
542 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
543 MAX_AGE: 1000 * 3600 * 3 // 3 hours
547 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
549 // ---------------------------------------------------------------------------
551 const CUSTOM_HTML_TAG_COMMENTS = {
552 TITLE: '<!-- title tag -->',
553 DESCRIPTION: '<!-- description tag -->',
554 CUSTOM_CSS: '<!-- custom css tag -->',
555 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
558 // ---------------------------------------------------------------------------
564 // ---------------------------------------------------------------------------
566 const TRACKER_RATE_LIMITS = {
567 INTERVAL: 60000 * 5, // 5 minutes
568 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
569 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
572 // ---------------------------------------------------------------------------
574 // Special constants for a test instance
575 if (isTestInstance() === true) {
576 ACTOR_FOLLOW_SCORE.BASE = 20
578 REMOTE_SCHEME.HTTP = 'http'
579 REMOTE_SCHEME.WS = 'ws'
583 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
584 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
585 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
587 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
589 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
590 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
591 SCHEDULER_INTERVALS_MS.updateVideos = 5000
593 VIDEO_VIEW_LIFETIME = 1000 // 1 second
595 JOB_ATTEMPTS['email'] = 1
597 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
600 updateWebserverConfig()
602 // ---------------------------------------------------------------------------
606 VIDEO_CAPTIONS_MIMETYPE_EXT,
617 LAST_MIGRATION_VERSION,
619 CUSTOM_HTML_TAG_COMMENTS,
620 BROADCAST_CONCURRENCY,
627 PRIVATE_RSA_KEY_SIZE,
628 ROUTE_CACHE_LIFETIME,
633 TORRENT_MIMETYPE_EXT,
637 ACTIVITY_PUB_ACTOR_TYPES,
646 VIDEO_TRANSCODING_FPS,
650 USER_PASSWORD_RESET_LIFETIME,
652 SCHEDULER_INTERVALS_MS,
653 STATIC_DOWNLOAD_PATHS,
656 CRAWL_REQUEST_CONCURRENCY,
657 JOB_COMPLETED_LIFETIME,
663 // ---------------------------------------------------------------------------
665 function getLocalConfigFilePath () {
666 const configSources = config.util.getConfigSources()
667 if (configSources.length === 0) throw new Error('Invalid config source.')
669 let filename = 'local'
670 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
671 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
673 return join(dirname(configSources[ 0 ].name), filename + '.json')
676 function updateWebserverConfig () {
677 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
678 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
681 function buildLanguages () {
682 const iso639 = require('iso-639-3')
684 const languages: { [ id: string ]: string } = {}
686 const additionalLanguages = {
687 'sgn': true, // Sign languages (macro language)
688 'ase': true, // American sign language
689 'sdl': true, // Arabian sign language
690 'bfi': true, // British sign language
691 'bzs': true, // Brazilian sign language
692 'csl': true, // Chinese sign language
693 'cse': true, // Czech sign language
694 'dsl': true, // Danish sign language
695 'fsl': true, // French sign language
696 'gsg': true, // German sign language
697 'pks': true, // Pakistan sign language
698 'jsl': true, // Japanese sign language
699 'sfs': true, // South African sign language
700 'swl': true, // Swedish sign language
701 'rsl': true, // Russian sign language: true
703 'epo': true, // Esperanto
704 'tlh': true, // Klingon
705 'jbo': true, // Lojban
706 'avk': true // Kotava
709 // Only add ISO639-1 languages and some sign languages (ISO639-3)
712 return (l.iso6391 !== null && l.type === 'living') ||
713 additionalLanguages[l.iso6393] === true
715 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
720 export function reloadConfig () {
722 function directory () {
723 if (process.env.NODE_CONFIG_DIR) {
724 return process.env.NODE_CONFIG_DIR
727 return join(root(), 'config')
731 for (const fileName in require.cache) {
732 if (-1 === fileName.indexOf(directory())) {
736 delete require.cache[fileName]
739 delete require.cache[require.resolve('config')]
744 config = require('config')
746 updateWebserverConfig()