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 SECURITYTXT: '2 hours',
61 NODEINFO: '10 minutes',
67 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
71 // ---------------------------------------------------------------------------
73 // Number of points we add/remove after a successful/bad request
74 const ACTOR_FOLLOW_SCORE = {
81 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
86 const REMOTE_SCHEME = {
91 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
92 'activitypub-http-broadcast': 5,
93 'activitypub-http-unicast': 5,
94 'activitypub-http-fetcher': 5,
95 'activitypub-follow': 5,
96 'video-file-import': 1,
102 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
103 'activitypub-http-broadcast': 1,
104 'activitypub-http-unicast': 5,
105 'activitypub-http-fetcher': 1,
106 'activitypub-follow': 3,
107 'video-file-import': 1,
113 const JOB_TTL: { [ id in JobType ]: number } = {
114 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
115 'activitypub-http-unicast': 60000 * 10, // 10 minutes
116 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
117 'activitypub-follow': 60000 * 10, // 10 minutes
118 'video-file-import': 1000 * 3600, // 1 hour
119 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
120 'video-import': 1000 * 3600 * 5, // 5 hours
121 'email': 60000 * 10, // 10 minutes
122 'videos-views': undefined // Unlimited
124 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
126 cron: '1 * * * *' // At 1 minutes past the hour
130 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
131 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
132 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
133 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
136 let SCHEDULER_INTERVALS_MS = {
137 badActorFollow: 60000 * 60, // 1 hour
138 removeOldJobs: 60000 * 60, // 1 hour
139 updateVideos: 60000, // 1 minute
140 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
143 // ---------------------------------------------------------------------------
146 CUSTOM_FILE: getLocalConfigFilePath(),
148 PORT: config.get<number>('listen.port'),
149 HOSTNAME: config.get<string>('listen.hostname')
152 DBNAME: 'peertube' + config.get<string>('database.suffix'),
153 HOSTNAME: config.get<string>('database.hostname'),
154 PORT: config.get<number>('database.port'),
155 USERNAME: config.get<string>('database.username'),
156 PASSWORD: config.get<string>('database.password'),
158 MAX: config.get<number>('database.pool.max')
162 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
163 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
164 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
165 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
166 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
169 HOSTNAME: config.get<string>('smtp.hostname'),
170 PORT: config.get<number>('smtp.port'),
171 USERNAME: config.get<string>('smtp.username'),
172 PASSWORD: config.get<string>('smtp.password'),
173 TLS: config.get<boolean>('smtp.tls'),
174 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
175 CA_FILE: config.get<string>('smtp.ca_file'),
176 FROM_ADDRESS: config.get<string>('smtp.from_address')
179 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
180 LOG_DIR: buildPath(config.get<string>('storage.logs')),
181 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
182 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
183 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
184 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
185 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
186 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
189 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
190 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
191 HOSTNAME: config.get<string>('webserver.hostname'),
192 PORT: config.get<number>('webserver.port'),
196 TRUST_PROXY: config.get<string[]>('trust_proxy'),
198 LEVEL: config.get<string>('log.level')
202 USERS: config.get<boolean>('search.remote_uri.users'),
203 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
208 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
212 get EMAIL () { return config.get<string>('admin.email') }
215 get ENABLED () { return config.get<boolean>('signup.enabled') },
216 get LIMIT () { return config.get<number>('signup.limit') },
217 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
220 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
221 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
226 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
227 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
230 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
231 get THREADS () { return config.get<number>('transcoding.threads') },
233 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
234 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
235 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
236 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
237 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
243 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
246 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
252 get SIZE () { return config.get<number>('cache.previews.size') }
255 get SIZE () { return config.get<number>('cache.captions.size') }
259 get NAME () { return config.get<string>('instance.name') },
260 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
261 get DESCRIPTION () { return config.get<string>('instance.description') },
262 get TERMS () { return config.get<string>('instance.terms') },
263 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
264 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
266 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
267 get CSS () { return config.get<string>('instance.customizations.css') }
269 get ROBOTS () { return config.get<string>('instance.robots') },
270 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
271 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
275 get USERNAME () { return config.get<string>('services.twitter.username') },
276 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
281 // ---------------------------------------------------------------------------
283 const CONSTRAINTS_FIELDS = {
285 NAME: { min: 3, max: 120 }, // Length
286 DESCRIPTION: { min: 3, max: 250 }, // Length
287 USERNAME: { min: 3, max: 20 }, // Length
288 PASSWORD: { min: 6, max: 255 }, // Length
289 VIDEO_QUOTA: { min: -1 },
290 VIDEO_QUOTA_DAILY: { min: -1 },
291 BLOCKED_REASON: { min: 3, max: 250 } // Length
294 REASON: { min: 2, max: 300 }, // Length
295 MODERATION_COMMENT: { min: 2, max: 300 } // Length
298 REASON: { min: 2, max: 300 } // Length
301 NAME: { min: 3, max: 120 }, // Length
302 DESCRIPTION: { min: 3, max: 500 }, // Length
303 SUPPORT: { min: 3, max: 500 }, // Length
304 URL: { min: 3, max: 2000 } // Length
308 EXTNAME: [ '.vtt', '.srt' ],
310 max: 2 * 1024 * 1024 // 2MB
315 URL: { min: 3, max: 2000 }, // Length
316 TORRENT_NAME: { min: 3, max: 255 }, // Length
318 EXTNAME: [ '.torrent' ],
320 max: 1024 * 200 // 200 KB
325 NAME: { min: 3, max: 120 }, // Length
326 LANGUAGE: { min: 1, max: 10 }, // Length
327 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
328 DESCRIPTION: { min: 3, max: 10000 }, // Length
329 SUPPORT: { min: 3, max: 500 }, // Length
331 EXTNAME: [ '.jpg', '.jpeg' ],
333 max: 2 * 1024 * 1024 // 2MB
336 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
337 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
338 DURATION: { min: 0 }, // Number
339 TAGS: { min: 0, max: 5 }, // Number of total tags
340 TAG: { min: 2, max: 30 }, // Length
341 THUMBNAIL: { min: 2, max: 30 },
342 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
345 DISLIKES: { min: 0 },
346 FILE_SIZE: { min: 10 },
347 URL: { min: 3, max: 2000 } // Length
350 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
351 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
352 URL: { min: 3, max: 2000 }, // Length
354 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
356 max: 2 * 1024 * 1024 // 2MB
364 TEXT: { min: 1, max: 3000 }, // Length
365 URL: { min: 3, max: 2000 } // Length
368 URL: { min: 3, max: 2000 } // Length
372 const RATES_LIMIT = {
374 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
375 MAX: 15 // 15 attempts
378 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
383 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
384 const VIDEO_TRANSCODING_FPS = {
388 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
391 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
396 const FFMPEG_NICE: { [ id: string ]: number } = {
397 THUMBNAIL: 2, // 2 just for don't blocking servers
401 const VIDEO_CATEGORIES = {
416 15: 'Science & Technology',
422 // See https://creativecommons.org/licenses/?lang=en
423 const VIDEO_LICENCES = {
425 2: 'Attribution - Share Alike',
426 3: 'Attribution - No Derivatives',
427 4: 'Attribution - Non Commercial',
428 5: 'Attribution - Non Commercial - Share Alike',
429 6: 'Attribution - Non Commercial - No Derivatives',
430 7: 'Public Domain Dedication'
433 const VIDEO_LANGUAGES = buildLanguages()
435 const VIDEO_PRIVACIES = {
436 [VideoPrivacy.PUBLIC]: 'Public',
437 [VideoPrivacy.UNLISTED]: 'Unlisted',
438 [VideoPrivacy.PRIVATE]: 'Private'
441 const VIDEO_STATES = {
442 [VideoState.PUBLISHED]: 'Published',
443 [VideoState.TO_TRANSCODE]: 'To transcode',
444 [VideoState.TO_IMPORT]: 'To import'
447 const VIDEO_IMPORT_STATES = {
448 [VideoImportState.FAILED]: 'Failed',
449 [VideoImportState.PENDING]: 'Pending',
450 [VideoImportState.SUCCESS]: 'Success'
453 const VIDEO_ABUSE_STATES = {
454 [VideoAbuseState.PENDING]: 'Pending',
455 [VideoAbuseState.REJECTED]: 'Rejected',
456 [VideoAbuseState.ACCEPTED]: 'Accepted'
459 const VIDEO_MIMETYPE_EXT = {
460 'video/webm': '.webm',
464 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
466 const IMAGE_MIMETYPE_EXT = {
472 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
474 'application/x-subrip': '.srt'
477 const TORRENT_MIMETYPE_EXT = {
478 'application/x-bittorrent': '.torrent'
481 // ---------------------------------------------------------------------------
490 // ---------------------------------------------------------------------------
492 const SERVER_ACTOR_NAME = 'peertube'
494 const ACTIVITY_PUB = {
495 POTENTIAL_ACCEPT_HEADERS: [
496 'application/activity+json',
497 'application/ld+json',
498 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
500 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
501 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
502 COLLECTION_ITEMS_PER_PAGE: 10,
503 FETCH_PAGE_LIMIT: 100,
505 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
506 TORRENT: [ 'application/x-bittorrent' ],
507 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
509 MAX_RECURSION_COMMENTS: 100,
510 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
511 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
514 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
517 APPLICATION: 'Application'
520 // ---------------------------------------------------------------------------
522 const PRIVATE_RSA_KEY_SIZE = 2048
524 // Password encryption
525 const BCRYPT_SALT_SIZE = 10
527 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
529 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
531 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
532 DO_NOT_LIST: 'do_not_list',
537 // ---------------------------------------------------------------------------
539 // Express static paths (router)
540 const STATIC_PATHS = {
541 PREVIEWS: '/static/previews/',
542 THUMBNAILS: '/static/thumbnails/',
543 TORRENTS: '/static/torrents/',
544 WEBSEED: '/static/webseed/',
545 AVATARS: '/static/avatars/',
546 VIDEO_CAPTIONS: '/static/video-captions/'
548 const STATIC_DOWNLOAD_PATHS = {
549 TORRENTS: '/download/torrents/',
550 VIDEOS: '/download/videos/'
554 let STATIC_MAX_AGE = '2h'
556 // Videos thumbnail size
557 const THUMBNAILS_SIZE = {
561 const PREVIEWS_SIZE = {
565 const AVATARS_SIZE = {
575 // Sub folders of cache directory
578 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
579 MAX_AGE: 1000 * 3600 * 3 // 3 hours
582 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
583 MAX_AGE: 1000 * 3600 * 3 // 3 hours
587 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
589 // ---------------------------------------------------------------------------
591 const CUSTOM_HTML_TAG_COMMENTS = {
592 TITLE: '<!-- title tag -->',
593 DESCRIPTION: '<!-- description tag -->',
594 CUSTOM_CSS: '<!-- custom css tag -->',
595 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
598 // ---------------------------------------------------------------------------
604 // ---------------------------------------------------------------------------
606 const TRACKER_RATE_LIMITS = {
607 INTERVAL: 60000 * 5, // 5 minutes
608 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
609 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
612 // ---------------------------------------------------------------------------
614 // Special constants for a test instance
615 if (isTestInstance() === true) {
616 ACTOR_FOLLOW_SCORE.BASE = 20
618 REMOTE_SCHEME.HTTP = 'http'
619 REMOTE_SCHEME.WS = 'ws'
623 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
624 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
625 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
627 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
629 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
630 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
631 SCHEDULER_INTERVALS_MS.updateVideos = 5000
632 REPEAT_JOBS['videos-views'] = { every: 5000 }
634 VIDEO_VIEW_LIFETIME = 1000 // 1 second
636 JOB_ATTEMPTS['email'] = 1
638 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
641 updateWebserverConfig()
643 // ---------------------------------------------------------------------------
647 VIDEO_CAPTIONS_MIMETYPE_EXT,
658 LAST_MIGRATION_VERSION,
660 CUSTOM_HTML_TAG_COMMENTS,
661 BROADCAST_CONCURRENCY,
668 PRIVATE_RSA_KEY_SIZE,
669 ROUTE_CACHE_LIFETIME,
674 TORRENT_MIMETYPE_EXT,
678 ACTIVITY_PUB_ACTOR_TYPES,
687 VIDEO_TRANSCODING_FPS,
691 USER_PASSWORD_RESET_LIFETIME,
692 USER_EMAIL_VERIFY_LIFETIME,
695 SCHEDULER_INTERVALS_MS,
697 STATIC_DOWNLOAD_PATHS,
700 CRAWL_REQUEST_CONCURRENCY,
701 JOB_COMPLETED_LIFETIME,
707 // ---------------------------------------------------------------------------
709 function getLocalConfigFilePath () {
710 const configSources = config.util.getConfigSources()
711 if (configSources.length === 0) throw new Error('Invalid config source.')
713 let filename = 'local'
714 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
715 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
717 return join(dirname(configSources[ 0 ].name), filename + '.json')
720 function updateWebserverConfig () {
721 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
722 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
725 function buildLanguages () {
726 const iso639 = require('iso-639-3')
728 const languages: { [ id: string ]: string } = {}
730 const additionalLanguages = {
731 'sgn': true, // Sign languages (macro language)
732 'ase': true, // American sign language
733 'sdl': true, // Arabian sign language
734 'bfi': true, // British sign language
735 'bzs': true, // Brazilian sign language
736 'csl': true, // Chinese sign language
737 'cse': true, // Czech sign language
738 'dsl': true, // Danish sign language
739 'fsl': true, // French sign language
740 'gsg': true, // German sign language
741 'pks': true, // Pakistan sign language
742 'jsl': true, // Japanese sign language
743 'sfs': true, // South African sign language
744 'swl': true, // Swedish sign language
745 'rsl': true, // Russian sign language: true
747 'epo': true, // Esperanto
748 'tlh': true, // Klingon
749 'jbo': true, // Lojban
750 'avk': true // Kotava
753 // Only add ISO639-1 languages and some sign languages (ISO639-3)
756 return (l.iso6391 !== null && l.type === 'living') ||
757 additionalLanguages[l.iso6393] === true
759 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
761 // Override Occitan label
762 languages['oc'] = 'Occitan'
767 export function reloadConfig () {
769 function directory () {
770 if (process.env.NODE_CONFIG_DIR) {
771 return process.env.NODE_CONFIG_DIR
774 return join(root(), 'config')
778 for (const fileName in require.cache) {
779 if (-1 === fileName.indexOf(directory())) {
783 delete require.cache[fileName]
786 delete require.cache[require.resolve('config')]
791 config = require('config')
793 updateWebserverConfig()