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 BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
104 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
105 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
106 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
109 let SCHEDULER_INTERVALS_MS = {
110 badActorFollow: 60000 * 60, // 1 hour
111 removeOldJobs: 60000 * 60, // 1 hour
112 updateVideos: 60000, // 1 minute
113 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
116 // ---------------------------------------------------------------------------
119 CUSTOM_FILE: getLocalConfigFilePath(),
121 PORT: config.get<number>('listen.port'),
122 HOSTNAME: config.get<string>('listen.hostname')
125 DBNAME: 'peertube' + config.get<string>('database.suffix'),
126 HOSTNAME: config.get<string>('database.hostname'),
127 PORT: config.get<number>('database.port'),
128 USERNAME: config.get<string>('database.username'),
129 PASSWORD: config.get<string>('database.password'),
131 MAX: config.get<number>('database.pool.max')
135 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
136 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
137 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
138 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
139 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
142 HOSTNAME: config.get<string>('smtp.hostname'),
143 PORT: config.get<number>('smtp.port'),
144 USERNAME: config.get<string>('smtp.username'),
145 PASSWORD: config.get<string>('smtp.password'),
146 TLS: config.get<boolean>('smtp.tls'),
147 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
148 CA_FILE: config.get<string>('smtp.ca_file'),
149 FROM_ADDRESS: config.get<string>('smtp.from_address')
152 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
153 LOG_DIR: buildPath(config.get<string>('storage.logs')),
154 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
155 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
156 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
157 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
158 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
159 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
162 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
163 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
164 HOSTNAME: config.get<string>('webserver.hostname'),
165 PORT: config.get<number>('webserver.port'),
169 TRUST_PROXY: config.get<string[]>('trust_proxy'),
171 LEVEL: config.get<string>('log.level')
174 get EMAIL () { return config.get<string>('admin.email') }
177 get ENABLED () { return config.get<boolean>('signup.enabled') },
178 get LIMIT () { return config.get<number>('signup.limit') },
181 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
182 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
187 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
190 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
191 get THREADS () { return config.get<number>('transcoding.threads') },
193 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
194 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
195 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
196 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
197 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
202 get SIZE () { return config.get<number>('cache.previews.size') }
205 get SIZE () { return config.get<number>('cache.captions.size') }
209 get NAME () { return config.get<string>('instance.name') },
210 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
211 get DESCRIPTION () { return config.get<string>('instance.description') },
212 get TERMS () { return config.get<string>('instance.terms') },
213 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
214 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
216 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
217 get CSS () { return config.get<string>('instance.customizations.css') }
219 get ROBOTS () { return config.get<string>('instance.robots') }
223 get USERNAME () { return config.get<string>('services.twitter.username') },
224 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
229 // ---------------------------------------------------------------------------
231 const CONSTRAINTS_FIELDS = {
233 NAME: { min: 3, max: 120 }, // Length
234 DESCRIPTION: { min: 3, max: 250 }, // Length
235 USERNAME: { min: 3, max: 20 }, // Length
236 PASSWORD: { min: 6, max: 255 }, // Length
237 VIDEO_QUOTA: { min: -1 }
240 REASON: { min: 2, max: 300 } // Length
243 NAME: { min: 3, max: 120 }, // Length
244 DESCRIPTION: { min: 3, max: 500 }, // Length
245 SUPPORT: { min: 3, max: 500 }, // Length
246 URL: { min: 3, max: 2000 } // Length
250 EXTNAME: [ '.vtt', '.srt' ],
252 max: 2 * 1024 * 1024 // 2MB
257 URL: { min: 3, max: 2000 } // Length
260 NAME: { min: 3, max: 120 }, // Length
261 LANGUAGE: { min: 1, max: 10 }, // Length
262 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
263 DESCRIPTION: { min: 3, max: 10000 }, // Length
264 SUPPORT: { min: 3, max: 500 }, // Length
266 EXTNAME: [ '.jpg', '.jpeg' ],
268 max: 2 * 1024 * 1024 // 2MB
271 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
272 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
273 DURATION: { min: 0 }, // Number
274 TAGS: { min: 0, max: 5 }, // Number of total tags
275 TAG: { min: 2, max: 30 }, // Length
276 THUMBNAIL: { min: 2, max: 30 },
277 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
280 DISLIKES: { min: 0 },
281 FILE_SIZE: { min: 10 },
282 URL: { min: 3, max: 2000 } // Length
285 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
286 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
287 URL: { min: 3, max: 2000 }, // Length
289 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
291 max: 2 * 1024 * 1024 // 2MB
299 TEXT: { min: 1, max: 3000 }, // Length
300 URL: { min: 3, max: 2000 } // Length
303 URL: { min: 3, max: 2000 } // Length
307 const RATES_LIMIT = {
309 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
310 MAX: 15 // 15 attempts
314 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
315 const VIDEO_TRANSCODING_FPS = {
319 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
322 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
327 const FFMPEG_NICE: { [ id: string ]: number } = {
328 THUMBNAIL: 2, // 2 just for don't blocking servers
332 const VIDEO_CATEGORIES = {
347 15: 'Science & Technology',
353 // See https://creativecommons.org/licenses/?lang=en
354 const VIDEO_LICENCES = {
356 2: 'Attribution - Share Alike',
357 3: 'Attribution - No Derivatives',
358 4: 'Attribution - Non Commercial',
359 5: 'Attribution - Non Commercial - Share Alike',
360 6: 'Attribution - Non Commercial - No Derivatives',
361 7: 'Public Domain Dedication'
364 const VIDEO_LANGUAGES = buildLanguages()
366 const VIDEO_PRIVACIES = {
367 [VideoPrivacy.PUBLIC]: 'Public',
368 [VideoPrivacy.UNLISTED]: 'Unlisted',
369 [VideoPrivacy.PRIVATE]: 'Private'
372 const VIDEO_STATES = {
373 [VideoState.PUBLISHED]: 'Published',
374 [VideoState.TO_TRANSCODE]: 'To transcode',
375 [VideoState.TO_IMPORT]: 'To import'
378 const VIDEO_IMPORT_STATES = {
379 [VideoImportState.FAILED]: 'Failed',
380 [VideoImportState.PENDING]: 'Pending',
381 [VideoImportState.SUCCESS]: 'Success'
384 const VIDEO_MIMETYPE_EXT = {
385 'video/webm': '.webm',
389 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
391 const IMAGE_MIMETYPE_EXT = {
397 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
399 'application/x-subrip': '.srt'
402 // ---------------------------------------------------------------------------
404 const SERVER_ACTOR_NAME = 'peertube'
406 const ACTIVITY_PUB = {
407 POTENTIAL_ACCEPT_HEADERS: [
408 'application/activity+json',
409 'application/ld+json',
410 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
412 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
413 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
414 COLLECTION_ITEMS_PER_PAGE: 10,
415 FETCH_PAGE_LIMIT: 100,
417 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
418 TORRENT: [ 'application/x-bittorrent' ],
419 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
421 MAX_RECURSION_COMMENTS: 100,
422 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
425 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
428 APPLICATION: 'Application'
431 // ---------------------------------------------------------------------------
433 const PRIVATE_RSA_KEY_SIZE = 2048
435 // Password encryption
436 const BCRYPT_SALT_SIZE = 10
438 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
440 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
441 DO_NOT_LIST: 'do_not_list',
446 // ---------------------------------------------------------------------------
448 // Express static paths (router)
449 const STATIC_PATHS = {
450 PREVIEWS: '/static/previews/',
451 THUMBNAILS: '/static/thumbnails/',
452 TORRENTS: '/static/torrents/',
453 WEBSEED: '/static/webseed/',
454 AVATARS: '/static/avatars/',
455 VIDEO_CAPTIONS: '/static/video-captions/'
457 const STATIC_DOWNLOAD_PATHS = {
458 TORRENTS: '/download/torrents/',
459 VIDEOS: '/download/videos/'
463 let STATIC_MAX_AGE = '2h'
465 // Videos thumbnail size
466 const THUMBNAILS_SIZE = {
470 const PREVIEWS_SIZE = {
474 const AVATARS_SIZE = {
484 // Sub folders of cache directory
487 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
488 MAX_AGE: 1000 * 3600 * 3 // 3 hours
491 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
492 MAX_AGE: 1000 * 3600 * 3 // 3 hours
496 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
498 // ---------------------------------------------------------------------------
500 const CUSTOM_HTML_TAG_COMMENTS = {
501 TITLE: '<!-- title tag -->',
502 DESCRIPTION: '<!-- description tag -->',
503 CUSTOM_CSS: '<!-- custom css tag -->',
504 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
507 // ---------------------------------------------------------------------------
513 // ---------------------------------------------------------------------------
515 const TRACKER_RATE_LIMITS = {
516 INTERVAL: 60000 * 5, // 5 minutes
517 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
518 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
521 // ---------------------------------------------------------------------------
523 // Special constants for a test instance
524 if (isTestInstance() === true) {
525 ACTOR_FOLLOW_SCORE.BASE = 20
527 REMOTE_SCHEME.HTTP = 'http'
528 REMOTE_SCHEME.WS = 'ws'
532 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
533 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
535 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
537 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
538 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
539 SCHEDULER_INTERVALS_MS.updateVideos = 5000
541 VIDEO_VIEW_LIFETIME = 1000 // 1 second
543 JOB_ATTEMPTS['email'] = 1
545 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
548 updateWebserverConfig()
550 // ---------------------------------------------------------------------------
554 VIDEO_CAPTIONS_MIMETYPE_EXT,
565 LAST_MIGRATION_VERSION,
567 CUSTOM_HTML_TAG_COMMENTS,
568 BROADCAST_CONCURRENCY,
575 PRIVATE_RSA_KEY_SIZE,
576 ROUTE_CACHE_LIFETIME,
583 ACTIVITY_PUB_ACTOR_TYPES,
592 VIDEO_TRANSCODING_FPS,
596 USER_PASSWORD_RESET_LIFETIME,
598 SCHEDULER_INTERVALS_MS,
599 STATIC_DOWNLOAD_PATHS,
602 JOB_COMPLETED_LIFETIME,
608 // ---------------------------------------------------------------------------
610 function getLocalConfigFilePath () {
611 const configSources = config.util.getConfigSources()
612 if (configSources.length === 0) throw new Error('Invalid config source.')
614 let filename = 'local'
615 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
616 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
618 return join(dirname(configSources[ 0 ].name), filename + '.json')
621 function updateWebserverConfig () {
622 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
623 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
626 function buildLanguages () {
627 const iso639 = require('iso-639-3')
629 const languages: { [ id: string ]: string } = {}
631 const additionalLanguages = {
632 'sgn': true, // Sign languages (macro language)
633 'ase': true, // American sign language
634 'sdl': true, // Arabian sign language
635 'bfi': true, // British sign language
636 'bzs': true, // Brazilian sign language
637 'csl': true, // Chinese sign language
638 'cse': true, // Czech sign language
639 'dsl': true, // Danish sign language
640 'fsl': true, // French sign language
641 'gsg': true, // German sign language
642 'pks': true, // Pakistan sign language
643 'jsl': true, // Japanese sign language
644 'sfs': true, // South African sign language
645 'swl': true, // Swedish sign language
646 'rsl': true, // Russian sign language: true
648 'epo': true, // Esperanto
649 'tlh': true, // Klingon
650 'jbo': true, // Lojban
651 'avk': true // Kotava
654 // Only add ISO639-1 languages and some sign languages (ISO639-3)
657 return (l.iso6391 !== null && l.type === 'living') ||
658 additionalLanguages[l.iso6393] === true
660 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
665 export function reloadConfig () {
667 function directory () {
668 if (process.env.NODE_CONFIG_DIR) {
669 return process.env.NODE_CONFIG_DIR
672 return join(root(), 'config')
676 for (const fileName in require.cache) {
677 if (-1 === fileName.indexOf(directory())) {
681 delete require.cache[fileName]
684 delete require.cache[require.resolve('config')]
689 config = require('config')
691 updateWebserverConfig()