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') }
212 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
218 get SIZE () { return config.get<number>('cache.previews.size') }
221 get SIZE () { return config.get<number>('cache.captions.size') }
225 get NAME () { return config.get<string>('instance.name') },
226 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
227 get DESCRIPTION () { return config.get<string>('instance.description') },
228 get TERMS () { return config.get<string>('instance.terms') },
229 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
230 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
232 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
233 get CSS () { return config.get<string>('instance.customizations.css') }
235 get ROBOTS () { return config.get<string>('instance.robots') }
239 get USERNAME () { return config.get<string>('services.twitter.username') },
240 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
245 // ---------------------------------------------------------------------------
247 const CONSTRAINTS_FIELDS = {
249 NAME: { min: 3, max: 120 }, // Length
250 DESCRIPTION: { min: 3, max: 250 }, // Length
251 USERNAME: { min: 3, max: 20 }, // Length
252 PASSWORD: { min: 6, max: 255 }, // Length
253 VIDEO_QUOTA: { min: -1 }
256 REASON: { min: 2, max: 300 } // Length
259 NAME: { min: 3, max: 120 }, // Length
260 DESCRIPTION: { min: 3, max: 500 }, // Length
261 SUPPORT: { min: 3, max: 500 }, // Length
262 URL: { min: 3, max: 2000 } // Length
266 EXTNAME: [ '.vtt', '.srt' ],
268 max: 2 * 1024 * 1024 // 2MB
273 URL: { min: 3, max: 2000 } // Length
276 NAME: { min: 3, max: 120 }, // Length
277 LANGUAGE: { min: 1, max: 10 }, // Length
278 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
279 DESCRIPTION: { min: 3, max: 10000 }, // Length
280 SUPPORT: { min: 3, max: 500 }, // Length
282 EXTNAME: [ '.jpg', '.jpeg' ],
284 max: 2 * 1024 * 1024 // 2MB
287 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
288 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
289 DURATION: { min: 0 }, // Number
290 TAGS: { min: 0, max: 5 }, // Number of total tags
291 TAG: { min: 2, max: 30 }, // Length
292 THUMBNAIL: { min: 2, max: 30 },
293 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
296 DISLIKES: { min: 0 },
297 FILE_SIZE: { min: 10 },
298 URL: { min: 3, max: 2000 } // Length
301 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
302 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
303 URL: { min: 3, max: 2000 }, // Length
305 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
307 max: 2 * 1024 * 1024 // 2MB
315 TEXT: { min: 1, max: 3000 }, // Length
316 URL: { min: 3, max: 2000 } // Length
319 URL: { min: 3, max: 2000 } // Length
323 const RATES_LIMIT = {
325 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
326 MAX: 15 // 15 attempts
330 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
331 const VIDEO_TRANSCODING_FPS = {
335 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
338 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
343 const FFMPEG_NICE: { [ id: string ]: number } = {
344 THUMBNAIL: 2, // 2 just for don't blocking servers
348 const VIDEO_CATEGORIES = {
363 15: 'Science & Technology',
369 // See https://creativecommons.org/licenses/?lang=en
370 const VIDEO_LICENCES = {
372 2: 'Attribution - Share Alike',
373 3: 'Attribution - No Derivatives',
374 4: 'Attribution - Non Commercial',
375 5: 'Attribution - Non Commercial - Share Alike',
376 6: 'Attribution - Non Commercial - No Derivatives',
377 7: 'Public Domain Dedication'
380 const VIDEO_LANGUAGES = buildLanguages()
382 const VIDEO_PRIVACIES = {
383 [VideoPrivacy.PUBLIC]: 'Public',
384 [VideoPrivacy.UNLISTED]: 'Unlisted',
385 [VideoPrivacy.PRIVATE]: 'Private'
388 const VIDEO_STATES = {
389 [VideoState.PUBLISHED]: 'Published',
390 [VideoState.TO_TRANSCODE]: 'To transcode',
391 [VideoState.TO_IMPORT]: 'To import'
394 const VIDEO_IMPORT_STATES = {
395 [VideoImportState.FAILED]: 'Failed',
396 [VideoImportState.PENDING]: 'Pending',
397 [VideoImportState.SUCCESS]: 'Success'
400 const VIDEO_MIMETYPE_EXT = {
401 'video/webm': '.webm',
405 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
407 const IMAGE_MIMETYPE_EXT = {
413 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
415 'application/x-subrip': '.srt'
418 // ---------------------------------------------------------------------------
420 const SERVER_ACTOR_NAME = 'peertube'
422 const ACTIVITY_PUB = {
423 POTENTIAL_ACCEPT_HEADERS: [
424 'application/activity+json',
425 'application/ld+json',
426 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
428 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
429 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
430 COLLECTION_ITEMS_PER_PAGE: 10,
431 FETCH_PAGE_LIMIT: 100,
433 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
434 TORRENT: [ 'application/x-bittorrent' ],
435 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
437 MAX_RECURSION_COMMENTS: 100,
438 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
441 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
444 APPLICATION: 'Application'
447 // ---------------------------------------------------------------------------
449 const PRIVATE_RSA_KEY_SIZE = 2048
451 // Password encryption
452 const BCRYPT_SALT_SIZE = 10
454 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
456 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
457 DO_NOT_LIST: 'do_not_list',
462 // ---------------------------------------------------------------------------
464 // Express static paths (router)
465 const STATIC_PATHS = {
466 PREVIEWS: '/static/previews/',
467 THUMBNAILS: '/static/thumbnails/',
468 TORRENTS: '/static/torrents/',
469 WEBSEED: '/static/webseed/',
470 AVATARS: '/static/avatars/',
471 VIDEO_CAPTIONS: '/static/video-captions/'
473 const STATIC_DOWNLOAD_PATHS = {
474 TORRENTS: '/download/torrents/',
475 VIDEOS: '/download/videos/'
479 let STATIC_MAX_AGE = '2h'
481 // Videos thumbnail size
482 const THUMBNAILS_SIZE = {
486 const PREVIEWS_SIZE = {
490 const AVATARS_SIZE = {
500 // Sub folders of cache directory
503 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
504 MAX_AGE: 1000 * 3600 * 3 // 3 hours
507 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
508 MAX_AGE: 1000 * 3600 * 3 // 3 hours
512 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
514 // ---------------------------------------------------------------------------
516 const CUSTOM_HTML_TAG_COMMENTS = {
517 TITLE: '<!-- title tag -->',
518 DESCRIPTION: '<!-- description tag -->',
519 CUSTOM_CSS: '<!-- custom css tag -->',
520 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
523 // ---------------------------------------------------------------------------
529 // ---------------------------------------------------------------------------
531 const TRACKER_RATE_LIMITS = {
532 INTERVAL: 60000 * 5, // 5 minutes
533 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
534 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
537 // ---------------------------------------------------------------------------
539 // Special constants for a test instance
540 if (isTestInstance() === true) {
541 ACTOR_FOLLOW_SCORE.BASE = 20
543 REMOTE_SCHEME.HTTP = 'http'
544 REMOTE_SCHEME.WS = 'ws'
548 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
549 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
551 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
553 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
554 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
555 SCHEDULER_INTERVALS_MS.updateVideos = 5000
557 VIDEO_VIEW_LIFETIME = 1000 // 1 second
559 JOB_ATTEMPTS['email'] = 1
561 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
564 updateWebserverConfig()
566 // ---------------------------------------------------------------------------
570 VIDEO_CAPTIONS_MIMETYPE_EXT,
581 LAST_MIGRATION_VERSION,
583 CUSTOM_HTML_TAG_COMMENTS,
584 BROADCAST_CONCURRENCY,
591 PRIVATE_RSA_KEY_SIZE,
592 ROUTE_CACHE_LIFETIME,
600 ACTIVITY_PUB_ACTOR_TYPES,
609 VIDEO_TRANSCODING_FPS,
612 USER_PASSWORD_RESET_LIFETIME,
614 SCHEDULER_INTERVALS_MS,
615 STATIC_DOWNLOAD_PATHS,
618 JOB_COMPLETED_LIFETIME,
624 // ---------------------------------------------------------------------------
626 function getLocalConfigFilePath () {
627 const configSources = config.util.getConfigSources()
628 if (configSources.length === 0) throw new Error('Invalid config source.')
630 let filename = 'local'
631 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
632 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
634 return join(dirname(configSources[ 0 ].name), filename + '.json')
637 function updateWebserverConfig () {
638 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
639 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
642 function buildLanguages () {
643 const iso639 = require('iso-639-3')
645 const languages: { [ id: string ]: string } = {}
647 const additionalLanguages = {
648 'sgn': true, // Sign languages (macro language)
649 'ase': true, // American sign language
650 'sdl': true, // Arabian sign language
651 'bfi': true, // British sign language
652 'bzs': true, // Brazilian sign language
653 'csl': true, // Chinese sign language
654 'cse': true, // Czech sign language
655 'dsl': true, // Danish sign language
656 'fsl': true, // French sign language
657 'gsg': true, // German sign language
658 'pks': true, // Pakistan sign language
659 'jsl': true, // Japanese sign language
660 'sfs': true, // South African sign language
661 'swl': true, // Swedish sign language
662 'rsl': true, // Russian sign language: true
664 'epo': true, // Esperanto
665 'tlh': true, // Klingon
666 'jbo': true, // Lojban
667 'avk': true // Kotava
670 // Only add ISO639-1 languages and some sign languages (ISO639-3)
673 return (l.iso6391 !== null && l.type === 'living') ||
674 additionalLanguages[l.iso6393] === true
676 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
681 export function reloadConfig () {
683 function directory () {
684 if (process.env.NODE_CONFIG_DIR) {
685 return process.env.NODE_CONFIG_DIR
688 return join(root(), 'config')
692 for (const fileName in require.cache) {
693 if (-1 === fileName.indexOf(directory())) {
697 delete require.cache[fileName]
700 delete require.cache[require.resolve('config')]
705 config = require('config')
707 updateWebserverConfig()