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 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: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
48 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
49 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
52 const OAUTH_LIFETIME = {
53 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
54 REFRESH_TOKEN: 1209600 // 2 weeks
57 const ROUTE_CACHE_LIFETIME = {
60 NODEINFO: '10 minutes',
66 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
70 // ---------------------------------------------------------------------------
72 // Number of points we add/remove after a successful/bad request
73 const ACTOR_FOLLOW_SCORE = {
80 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
85 const REMOTE_SCHEME = {
90 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
91 'activitypub-http-broadcast': 5,
92 'activitypub-http-unicast': 5,
93 'activitypub-http-fetcher': 5,
94 'activitypub-follow': 5,
95 'video-file-import': 1,
101 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
102 'activitypub-http-broadcast': 1,
103 'activitypub-http-unicast': 5,
104 'activitypub-http-fetcher': 1,
105 'activitypub-follow': 3,
106 'video-file-import': 1,
112 const JOB_TTL: { [ id in JobType ]: number } = {
113 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
114 'activitypub-http-unicast': 60000 * 10, // 10 minutes
115 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
116 'activitypub-follow': 60000 * 10, // 10 minutes
117 'video-file-import': 1000 * 3600, // 1 hour
118 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
119 'video-import': 1000 * 3600 * 5, // 5 hours
120 'email': 60000 * 10, // 10 minutes
121 'videos-views': undefined // Unlimited
123 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
125 cron: '1 * * * *' // At 1 minutes past the hour
129 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
130 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
131 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
132 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
135 let SCHEDULER_INTERVALS_MS = {
136 badActorFollow: 60000 * 60, // 1 hour
137 removeOldJobs: 60000 * 60, // 1 hour
138 updateVideos: 60000, // 1 minute
139 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
142 // ---------------------------------------------------------------------------
145 CUSTOM_FILE: getLocalConfigFilePath(),
147 PORT: config.get<number>('listen.port'),
148 HOSTNAME: config.get<string>('listen.hostname')
151 DBNAME: 'peertube' + config.get<string>('database.suffix'),
152 HOSTNAME: config.get<string>('database.hostname'),
153 PORT: config.get<number>('database.port'),
154 USERNAME: config.get<string>('database.username'),
155 PASSWORD: config.get<string>('database.password'),
157 MAX: config.get<number>('database.pool.max')
161 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
162 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
163 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
164 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
165 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
168 HOSTNAME: config.get<string>('smtp.hostname'),
169 PORT: config.get<number>('smtp.port'),
170 USERNAME: config.get<string>('smtp.username'),
171 PASSWORD: config.get<string>('smtp.password'),
172 TLS: config.get<boolean>('smtp.tls'),
173 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
174 CA_FILE: config.get<string>('smtp.ca_file'),
175 FROM_ADDRESS: config.get<string>('smtp.from_address')
178 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
179 LOG_DIR: buildPath(config.get<string>('storage.logs')),
180 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
181 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
182 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
183 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
184 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
185 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
188 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
189 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
190 HOSTNAME: config.get<string>('webserver.hostname'),
191 PORT: config.get<number>('webserver.port'),
195 TRUST_PROXY: config.get<string[]>('trust_proxy'),
197 LEVEL: config.get<string>('log.level')
201 USERS: config.get<boolean>('search.remote_uri.users'),
202 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
207 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
211 get EMAIL () { return config.get<string>('admin.email') }
214 get ENABLED () { return config.get<boolean>('signup.enabled') },
215 get LIMIT () { return config.get<number>('signup.limit') },
216 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
219 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
220 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
225 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
226 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
229 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
230 get THREADS () { return config.get<number>('transcoding.threads') },
232 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
233 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
234 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
235 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
236 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
242 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
245 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
251 get SIZE () { return config.get<number>('cache.previews.size') }
254 get SIZE () { return config.get<number>('cache.captions.size') }
258 get NAME () { return config.get<string>('instance.name') },
259 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
260 get DESCRIPTION () { return config.get<string>('instance.description') },
261 get TERMS () { return config.get<string>('instance.terms') },
262 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
263 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
265 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
266 get CSS () { return config.get<string>('instance.customizations.css') }
268 get ROBOTS () { return config.get<string>('instance.robots') }
272 get USERNAME () { return config.get<string>('services.twitter.username') },
273 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
278 // ---------------------------------------------------------------------------
280 const CONSTRAINTS_FIELDS = {
282 NAME: { min: 3, max: 120 }, // Length
283 DESCRIPTION: { min: 3, max: 250 }, // Length
284 USERNAME: { min: 3, max: 20 }, // Length
285 PASSWORD: { min: 6, max: 255 }, // Length
286 VIDEO_QUOTA: { min: -1 },
287 VIDEO_QUOTA_DAILY: { min: -1 },
288 BLOCKED_REASON: { min: 3, max: 250 } // Length
291 REASON: { min: 2, max: 300 }, // Length
292 MODERATION_COMMENT: { min: 2, max: 300 } // Length
295 REASON: { min: 2, max: 300 } // Length
298 NAME: { min: 3, max: 120 }, // Length
299 DESCRIPTION: { min: 3, max: 500 }, // Length
300 SUPPORT: { min: 3, max: 500 }, // Length
301 URL: { min: 3, max: 2000 } // Length
305 EXTNAME: [ '.vtt', '.srt' ],
307 max: 2 * 1024 * 1024 // 2MB
312 URL: { min: 3, max: 2000 }, // Length
313 TORRENT_NAME: { min: 3, max: 255 }, // Length
315 EXTNAME: [ '.torrent' ],
317 max: 1024 * 200 // 200 KB
322 NAME: { min: 3, max: 120 }, // Length
323 LANGUAGE: { min: 1, max: 10 }, // Length
324 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
325 DESCRIPTION: { min: 3, max: 10000 }, // Length
326 SUPPORT: { min: 3, max: 500 }, // Length
328 EXTNAME: [ '.jpg', '.jpeg' ],
330 max: 2 * 1024 * 1024 // 2MB
333 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
334 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
335 DURATION: { min: 0 }, // Number
336 TAGS: { min: 0, max: 5 }, // Number of total tags
337 TAG: { min: 2, max: 30 }, // Length
338 THUMBNAIL: { min: 2, max: 30 },
339 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
342 DISLIKES: { min: 0 },
343 FILE_SIZE: { min: 10 },
344 URL: { min: 3, max: 2000 } // Length
347 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
348 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
349 URL: { min: 3, max: 2000 }, // Length
351 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
353 max: 2 * 1024 * 1024 // 2MB
361 TEXT: { min: 1, max: 3000 }, // Length
362 URL: { min: 3, max: 2000 } // Length
365 URL: { min: 3, max: 2000 } // Length
369 const RATES_LIMIT = {
371 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
372 MAX: 15 // 15 attempts
375 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
380 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
381 const VIDEO_TRANSCODING_FPS = {
385 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
388 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
393 const FFMPEG_NICE: { [ id: string ]: number } = {
394 THUMBNAIL: 2, // 2 just for don't blocking servers
398 const VIDEO_CATEGORIES = {
413 15: 'Science & Technology',
419 // See https://creativecommons.org/licenses/?lang=en
420 const VIDEO_LICENCES = {
422 2: 'Attribution - Share Alike',
423 3: 'Attribution - No Derivatives',
424 4: 'Attribution - Non Commercial',
425 5: 'Attribution - Non Commercial - Share Alike',
426 6: 'Attribution - Non Commercial - No Derivatives',
427 7: 'Public Domain Dedication'
430 const VIDEO_LANGUAGES = buildLanguages()
432 const VIDEO_PRIVACIES = {
433 [VideoPrivacy.PUBLIC]: 'Public',
434 [VideoPrivacy.UNLISTED]: 'Unlisted',
435 [VideoPrivacy.PRIVATE]: 'Private'
438 const VIDEO_STATES = {
439 [VideoState.PUBLISHED]: 'Published',
440 [VideoState.TO_TRANSCODE]: 'To transcode',
441 [VideoState.TO_IMPORT]: 'To import'
444 const VIDEO_IMPORT_STATES = {
445 [VideoImportState.FAILED]: 'Failed',
446 [VideoImportState.PENDING]: 'Pending',
447 [VideoImportState.SUCCESS]: 'Success'
450 const VIDEO_ABUSE_STATES = {
451 [VideoAbuseState.PENDING]: 'Pending',
452 [VideoAbuseState.REJECTED]: 'Rejected',
453 [VideoAbuseState.ACCEPTED]: 'Accepted'
456 const VIDEO_MIMETYPE_EXT = {
457 'video/webm': '.webm',
461 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
463 const IMAGE_MIMETYPE_EXT = {
469 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
471 'application/x-subrip': '.srt'
474 const TORRENT_MIMETYPE_EXT = {
475 'application/x-bittorrent': '.torrent'
478 // ---------------------------------------------------------------------------
487 // ---------------------------------------------------------------------------
489 const SERVER_ACTOR_NAME = 'peertube'
491 const ACTIVITY_PUB = {
492 POTENTIAL_ACCEPT_HEADERS: [
493 'application/activity+json',
494 'application/ld+json',
495 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
497 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
498 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
499 COLLECTION_ITEMS_PER_PAGE: 10,
500 FETCH_PAGE_LIMIT: 100,
502 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
503 TORRENT: [ 'application/x-bittorrent' ],
504 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
506 MAX_RECURSION_COMMENTS: 100,
507 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
508 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
511 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
514 APPLICATION: 'Application'
517 // ---------------------------------------------------------------------------
519 const PRIVATE_RSA_KEY_SIZE = 2048
521 // Password encryption
522 const BCRYPT_SALT_SIZE = 10
524 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
526 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
528 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
529 DO_NOT_LIST: 'do_not_list',
534 // ---------------------------------------------------------------------------
536 // Express static paths (router)
537 const STATIC_PATHS = {
538 PREVIEWS: '/static/previews/',
539 THUMBNAILS: '/static/thumbnails/',
540 TORRENTS: '/static/torrents/',
541 WEBSEED: '/static/webseed/',
542 AVATARS: '/static/avatars/',
543 VIDEO_CAPTIONS: '/static/video-captions/'
545 const STATIC_DOWNLOAD_PATHS = {
546 TORRENTS: '/download/torrents/',
547 VIDEOS: '/download/videos/'
551 let STATIC_MAX_AGE = '2h'
553 // Videos thumbnail size
554 const THUMBNAILS_SIZE = {
558 const PREVIEWS_SIZE = {
562 const AVATARS_SIZE = {
572 // Sub folders of cache directory
575 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
576 MAX_AGE: 1000 * 3600 * 3 // 3 hours
579 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
580 MAX_AGE: 1000 * 3600 * 3 // 3 hours
584 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
586 // ---------------------------------------------------------------------------
588 const CUSTOM_HTML_TAG_COMMENTS = {
589 TITLE: '<!-- title tag -->',
590 DESCRIPTION: '<!-- description tag -->',
591 CUSTOM_CSS: '<!-- custom css tag -->',
592 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
595 // ---------------------------------------------------------------------------
601 // ---------------------------------------------------------------------------
603 const TRACKER_RATE_LIMITS = {
604 INTERVAL: 60000 * 5, // 5 minutes
605 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
606 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
609 // ---------------------------------------------------------------------------
611 // Special constants for a test instance
612 if (isTestInstance() === true) {
613 ACTOR_FOLLOW_SCORE.BASE = 20
615 REMOTE_SCHEME.HTTP = 'http'
616 REMOTE_SCHEME.WS = 'ws'
620 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
621 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
622 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
624 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
626 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
627 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
628 SCHEDULER_INTERVALS_MS.updateVideos = 5000
629 REPEAT_JOBS['videos-views'] = { every: 5000 }
631 VIDEO_VIEW_LIFETIME = 1000 // 1 second
633 JOB_ATTEMPTS['email'] = 1
635 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
638 updateWebserverConfig()
640 // ---------------------------------------------------------------------------
644 VIDEO_CAPTIONS_MIMETYPE_EXT,
655 LAST_MIGRATION_VERSION,
657 CUSTOM_HTML_TAG_COMMENTS,
658 BROADCAST_CONCURRENCY,
665 PRIVATE_RSA_KEY_SIZE,
666 ROUTE_CACHE_LIFETIME,
671 TORRENT_MIMETYPE_EXT,
675 ACTIVITY_PUB_ACTOR_TYPES,
684 VIDEO_TRANSCODING_FPS,
688 USER_PASSWORD_RESET_LIFETIME,
689 USER_EMAIL_VERIFY_LIFETIME,
692 SCHEDULER_INTERVALS_MS,
694 STATIC_DOWNLOAD_PATHS,
697 CRAWL_REQUEST_CONCURRENCY,
698 JOB_COMPLETED_LIFETIME,
704 // ---------------------------------------------------------------------------
706 function getLocalConfigFilePath () {
707 const configSources = config.util.getConfigSources()
708 if (configSources.length === 0) throw new Error('Invalid config source.')
710 let filename = 'local'
711 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
712 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
714 return join(dirname(configSources[ 0 ].name), filename + '.json')
717 function updateWebserverConfig () {
718 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
719 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
722 function buildLanguages () {
723 const iso639 = require('iso-639-3')
725 const languages: { [ id: string ]: string } = {}
727 const additionalLanguages = {
728 'sgn': true, // Sign languages (macro language)
729 'ase': true, // American sign language
730 'sdl': true, // Arabian sign language
731 'bfi': true, // British sign language
732 'bzs': true, // Brazilian sign language
733 'csl': true, // Chinese sign language
734 'cse': true, // Czech sign language
735 'dsl': true, // Danish sign language
736 'fsl': true, // French sign language
737 'gsg': true, // German sign language
738 'pks': true, // Pakistan sign language
739 'jsl': true, // Japanese sign language
740 'sfs': true, // South African sign language
741 'swl': true, // Swedish sign language
742 'rsl': true, // Russian sign language: true
744 'epo': true, // Esperanto
745 'tlh': true, // Klingon
746 'jbo': true, // Lojban
747 'avk': true // Kotava
750 // Only add ISO639-1 languages and some sign languages (ISO639-3)
753 return (l.iso6391 !== null && l.type === 'living') ||
754 additionalLanguages[l.iso6393] === true
756 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
761 export function reloadConfig () {
763 function directory () {
764 if (process.env.NODE_CONFIG_DIR) {
765 return process.env.NODE_CONFIG_DIR
768 return join(root(), 'config')
772 for (const fileName in require.cache) {
773 if (-1 === fileName.indexOf(directory())) {
777 delete require.cache[fileName]
780 delete require.cache[require.resolve('config')]
785 config = require('config')
787 updateWebserverConfig()