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 { VideoAbuseState, VideoImportState, 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 { CronRepeatOptions, EveryRepeatOptions } from 'bull'
13 // Use a variable to reload the configuration if we need
14 let config: IConfig = require('config')
16 // ---------------------------------------------------------------------------
18 const LAST_MIGRATION_VERSION = 265
20 // ---------------------------------------------------------------------------
23 const API_VERSION = 'v1'
32 // Sortable columns per schema
33 const SORTABLE_COLUMNS = {
34 USERS: [ 'id', 'username', 'createdAt' ],
35 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
36 ACCOUNTS: [ 'createdAt' ],
37 JOBS: [ 'createdAt' ],
38 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
39 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
40 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
41 VIDEO_IMPORTS: [ 'createdAt' ],
42 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
43 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
44 FOLLOWERS: [ 'createdAt' ],
45 FOLLOWING: [ 'createdAt' ],
47 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
48 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
51 const OAUTH_LIFETIME = {
52 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
53 REFRESH_TOKEN: 1209600 // 2 weeks
56 const ROUTE_CACHE_LIFETIME = {
59 NODEINFO: '10 minutes',
65 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
69 // ---------------------------------------------------------------------------
71 // Number of points we add/remove after a successful/bad request
72 const ACTOR_FOLLOW_SCORE = {
79 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
84 const REMOTE_SCHEME = {
89 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
90 'activitypub-http-broadcast': 5,
91 'activitypub-http-unicast': 5,
92 'activitypub-http-fetcher': 5,
93 'activitypub-follow': 5,
94 'video-file-import': 1,
100 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
101 'activitypub-http-broadcast': 1,
102 'activitypub-http-unicast': 5,
103 'activitypub-http-fetcher': 1,
104 'activitypub-follow': 3,
105 'video-file-import': 1,
111 const JOB_TTL: { [ id in JobType ]: number } = {
112 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
113 'activitypub-http-unicast': 60000 * 10, // 10 minutes
114 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
115 'activitypub-follow': 60000 * 10, // 10 minutes
116 'video-file-import': 1000 * 3600, // 1 hour
117 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
118 'video-import': 1000 * 3600 * 5, // 5 hours
119 'email': 60000 * 10, // 10 minutes
120 'videos-views': undefined // Unlimited
122 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
124 cron: '1 * * * *' // At 1 minutes past the hour
128 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
129 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
130 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
131 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
134 let SCHEDULER_INTERVALS_MS = {
135 badActorFollow: 60000 * 60, // 1 hour
136 removeOldJobs: 60000 * 60, // 1 hour
137 updateVideos: 60000, // 1 minute
138 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
141 // ---------------------------------------------------------------------------
144 CUSTOM_FILE: getLocalConfigFilePath(),
146 PORT: config.get<number>('listen.port'),
147 HOSTNAME: config.get<string>('listen.hostname')
150 DBNAME: 'peertube' + config.get<string>('database.suffix'),
151 HOSTNAME: config.get<string>('database.hostname'),
152 PORT: config.get<number>('database.port'),
153 USERNAME: config.get<string>('database.username'),
154 PASSWORD: config.get<string>('database.password'),
156 MAX: config.get<number>('database.pool.max')
160 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
161 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
162 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
163 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
164 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
167 HOSTNAME: config.get<string>('smtp.hostname'),
168 PORT: config.get<number>('smtp.port'),
169 USERNAME: config.get<string>('smtp.username'),
170 PASSWORD: config.get<string>('smtp.password'),
171 TLS: config.get<boolean>('smtp.tls'),
172 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
173 CA_FILE: config.get<string>('smtp.ca_file'),
174 FROM_ADDRESS: config.get<string>('smtp.from_address')
177 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
178 LOG_DIR: buildPath(config.get<string>('storage.logs')),
179 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
180 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
181 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
182 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
183 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
184 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
187 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
188 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
189 HOSTNAME: config.get<string>('webserver.hostname'),
190 PORT: config.get<number>('webserver.port'),
194 TRUST_PROXY: config.get<string[]>('trust_proxy'),
196 LEVEL: config.get<string>('log.level')
200 USERS: config.get<boolean>('search.remote_uri.users'),
201 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
205 get EMAIL () { return config.get<string>('admin.email') }
208 get ENABLED () { return config.get<boolean>('signup.enabled') },
209 get LIMIT () { return config.get<number>('signup.limit') },
210 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
213 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
214 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
219 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
220 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
223 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
224 get THREADS () { return config.get<number>('transcoding.threads') },
226 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
227 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
228 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
229 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
230 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
236 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
239 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
245 get SIZE () { return config.get<number>('cache.previews.size') }
248 get SIZE () { return config.get<number>('cache.captions.size') }
252 get NAME () { return config.get<string>('instance.name') },
253 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
254 get DESCRIPTION () { return config.get<string>('instance.description') },
255 get TERMS () { return config.get<string>('instance.terms') },
256 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
257 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
259 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
260 get CSS () { return config.get<string>('instance.customizations.css') }
262 get ROBOTS () { return config.get<string>('instance.robots') }
266 get USERNAME () { return config.get<string>('services.twitter.username') },
267 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
272 // ---------------------------------------------------------------------------
274 const CONSTRAINTS_FIELDS = {
276 NAME: { min: 3, max: 120 }, // Length
277 DESCRIPTION: { min: 3, max: 250 }, // Length
278 USERNAME: { min: 3, max: 20 }, // Length
279 PASSWORD: { min: 6, max: 255 }, // Length
280 VIDEO_QUOTA: { min: -1 },
281 VIDEO_QUOTA_DAILY: { min: -1 },
282 BLOCKED_REASON: { min: 3, max: 250 } // Length
285 REASON: { min: 2, max: 300 }, // Length
286 MODERATION_COMMENT: { min: 2, max: 300 } // Length
289 REASON: { min: 2, max: 300 } // Length
292 NAME: { min: 3, max: 120 }, // Length
293 DESCRIPTION: { min: 3, max: 500 }, // Length
294 SUPPORT: { min: 3, max: 500 }, // Length
295 URL: { min: 3, max: 2000 } // Length
299 EXTNAME: [ '.vtt', '.srt' ],
301 max: 2 * 1024 * 1024 // 2MB
306 URL: { min: 3, max: 2000 }, // Length
307 TORRENT_NAME: { min: 3, max: 255 }, // Length
309 EXTNAME: [ '.torrent' ],
311 max: 1024 * 200 // 200 KB
316 NAME: { min: 3, max: 120 }, // Length
317 LANGUAGE: { min: 1, max: 10 }, // Length
318 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
319 DESCRIPTION: { min: 3, max: 10000 }, // Length
320 SUPPORT: { min: 3, max: 500 }, // Length
322 EXTNAME: [ '.jpg', '.jpeg' ],
324 max: 2 * 1024 * 1024 // 2MB
327 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
328 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
329 DURATION: { min: 0 }, // Number
330 TAGS: { min: 0, max: 5 }, // Number of total tags
331 TAG: { min: 2, max: 30 }, // Length
332 THUMBNAIL: { min: 2, max: 30 },
333 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
336 DISLIKES: { min: 0 },
337 FILE_SIZE: { min: 10 },
338 URL: { min: 3, max: 2000 } // Length
341 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
342 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
343 URL: { min: 3, max: 2000 }, // Length
345 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
347 max: 2 * 1024 * 1024 // 2MB
355 TEXT: { min: 1, max: 3000 }, // Length
356 URL: { min: 3, max: 2000 } // Length
359 URL: { min: 3, max: 2000 } // Length
363 const RATES_LIMIT = {
365 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
366 MAX: 15 // 15 attempts
370 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
371 const VIDEO_TRANSCODING_FPS = {
375 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
378 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
383 const FFMPEG_NICE: { [ id: string ]: number } = {
384 THUMBNAIL: 2, // 2 just for don't blocking servers
388 const VIDEO_CATEGORIES = {
403 15: 'Science & Technology',
409 // See https://creativecommons.org/licenses/?lang=en
410 const VIDEO_LICENCES = {
412 2: 'Attribution - Share Alike',
413 3: 'Attribution - No Derivatives',
414 4: 'Attribution - Non Commercial',
415 5: 'Attribution - Non Commercial - Share Alike',
416 6: 'Attribution - Non Commercial - No Derivatives',
417 7: 'Public Domain Dedication'
420 const VIDEO_LANGUAGES = buildLanguages()
422 const VIDEO_PRIVACIES = {
423 [VideoPrivacy.PUBLIC]: 'Public',
424 [VideoPrivacy.UNLISTED]: 'Unlisted',
425 [VideoPrivacy.PRIVATE]: 'Private'
428 const VIDEO_STATES = {
429 [VideoState.PUBLISHED]: 'Published',
430 [VideoState.TO_TRANSCODE]: 'To transcode',
431 [VideoState.TO_IMPORT]: 'To import'
434 const VIDEO_IMPORT_STATES = {
435 [VideoImportState.FAILED]: 'Failed',
436 [VideoImportState.PENDING]: 'Pending',
437 [VideoImportState.SUCCESS]: 'Success'
440 const VIDEO_ABUSE_STATES = {
441 [VideoAbuseState.PENDING]: 'Pending',
442 [VideoAbuseState.REJECTED]: 'Rejected',
443 [VideoAbuseState.ACCEPTED]: 'Accepted'
446 const VIDEO_MIMETYPE_EXT = {
447 'video/webm': '.webm',
451 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
453 const IMAGE_MIMETYPE_EXT = {
459 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
461 'application/x-subrip': '.srt'
464 const TORRENT_MIMETYPE_EXT = {
465 'application/x-bittorrent': '.torrent'
468 // ---------------------------------------------------------------------------
477 // ---------------------------------------------------------------------------
479 const SERVER_ACTOR_NAME = 'peertube'
481 const ACTIVITY_PUB = {
482 POTENTIAL_ACCEPT_HEADERS: [
483 'application/activity+json',
484 'application/ld+json',
485 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
487 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
488 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
489 COLLECTION_ITEMS_PER_PAGE: 10,
490 FETCH_PAGE_LIMIT: 100,
492 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
493 TORRENT: [ 'application/x-bittorrent' ],
494 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
496 MAX_RECURSION_COMMENTS: 100,
497 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
498 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
501 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
504 APPLICATION: 'Application'
507 // ---------------------------------------------------------------------------
509 const PRIVATE_RSA_KEY_SIZE = 2048
511 // Password encryption
512 const BCRYPT_SALT_SIZE = 10
514 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
516 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
518 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
519 DO_NOT_LIST: 'do_not_list',
524 // ---------------------------------------------------------------------------
526 // Express static paths (router)
527 const STATIC_PATHS = {
528 PREVIEWS: '/static/previews/',
529 THUMBNAILS: '/static/thumbnails/',
530 TORRENTS: '/static/torrents/',
531 WEBSEED: '/static/webseed/',
532 AVATARS: '/static/avatars/',
533 VIDEO_CAPTIONS: '/static/video-captions/'
535 const STATIC_DOWNLOAD_PATHS = {
536 TORRENTS: '/download/torrents/',
537 VIDEOS: '/download/videos/'
541 let STATIC_MAX_AGE = '2h'
543 // Videos thumbnail size
544 const THUMBNAILS_SIZE = {
548 const PREVIEWS_SIZE = {
552 const AVATARS_SIZE = {
562 // Sub folders of cache directory
565 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
566 MAX_AGE: 1000 * 3600 * 3 // 3 hours
569 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
570 MAX_AGE: 1000 * 3600 * 3 // 3 hours
574 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
576 // ---------------------------------------------------------------------------
578 const CUSTOM_HTML_TAG_COMMENTS = {
579 TITLE: '<!-- title tag -->',
580 DESCRIPTION: '<!-- description tag -->',
581 CUSTOM_CSS: '<!-- custom css tag -->',
582 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
585 // ---------------------------------------------------------------------------
591 // ---------------------------------------------------------------------------
593 const TRACKER_RATE_LIMITS = {
594 INTERVAL: 60000 * 5, // 5 minutes
595 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
596 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
599 // ---------------------------------------------------------------------------
601 // Special constants for a test instance
602 if (isTestInstance() === true) {
603 ACTOR_FOLLOW_SCORE.BASE = 20
605 REMOTE_SCHEME.HTTP = 'http'
606 REMOTE_SCHEME.WS = 'ws'
610 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
611 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
612 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
614 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
616 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
617 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
618 SCHEDULER_INTERVALS_MS.updateVideos = 5000
619 REPEAT_JOBS['videos-views'] = { every: 5000 }
621 VIDEO_VIEW_LIFETIME = 1000 // 1 second
623 JOB_ATTEMPTS['email'] = 1
625 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
628 updateWebserverConfig()
630 // ---------------------------------------------------------------------------
634 VIDEO_CAPTIONS_MIMETYPE_EXT,
645 LAST_MIGRATION_VERSION,
647 CUSTOM_HTML_TAG_COMMENTS,
648 BROADCAST_CONCURRENCY,
655 PRIVATE_RSA_KEY_SIZE,
656 ROUTE_CACHE_LIFETIME,
661 TORRENT_MIMETYPE_EXT,
665 ACTIVITY_PUB_ACTOR_TYPES,
674 VIDEO_TRANSCODING_FPS,
678 USER_PASSWORD_RESET_LIFETIME,
679 USER_EMAIL_VERIFY_LIFETIME,
682 SCHEDULER_INTERVALS_MS,
684 STATIC_DOWNLOAD_PATHS,
687 CRAWL_REQUEST_CONCURRENCY,
688 JOB_COMPLETED_LIFETIME,
694 // ---------------------------------------------------------------------------
696 function getLocalConfigFilePath () {
697 const configSources = config.util.getConfigSources()
698 if (configSources.length === 0) throw new Error('Invalid config source.')
700 let filename = 'local'
701 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
702 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
704 return join(dirname(configSources[ 0 ].name), filename + '.json')
707 function updateWebserverConfig () {
708 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
709 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
712 function buildLanguages () {
713 const iso639 = require('iso-639-3')
715 const languages: { [ id: string ]: string } = {}
717 const additionalLanguages = {
718 'sgn': true, // Sign languages (macro language)
719 'ase': true, // American sign language
720 'sdl': true, // Arabian sign language
721 'bfi': true, // British sign language
722 'bzs': true, // Brazilian sign language
723 'csl': true, // Chinese sign language
724 'cse': true, // Czech sign language
725 'dsl': true, // Danish sign language
726 'fsl': true, // French sign language
727 'gsg': true, // German sign language
728 'pks': true, // Pakistan sign language
729 'jsl': true, // Japanese sign language
730 'sfs': true, // South African sign language
731 'swl': true, // Swedish sign language
732 'rsl': true, // Russian sign language: true
734 'epo': true, // Esperanto
735 'tlh': true, // Klingon
736 'jbo': true, // Lojban
737 'avk': true // Kotava
740 // Only add ISO639-1 languages and some sign languages (ISO639-3)
743 return (l.iso6391 !== null && l.type === 'living') ||
744 additionalLanguages[l.iso6393] === true
746 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
751 export function reloadConfig () {
753 function directory () {
754 if (process.env.NODE_CONFIG_DIR) {
755 return process.env.NODE_CONFIG_DIR
758 return join(root(), 'config')
762 for (const fileName in require.cache) {
763 if (-1 === fileName.indexOf(directory())) {
767 delete require.cache[fileName]
770 delete require.cache[require.resolve('config')]
775 config = require('config')
777 updateWebserverConfig()