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, VideoAbuseState, VideoImportState } 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'
12 // Use a variable to reload the configuration if we need
13 let config: IConfig = require('config')
15 // ---------------------------------------------------------------------------
17 const LAST_MIGRATION_VERSION = 255
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
31 // Sortable columns per schema
32 const SORTABLE_COLUMNS = {
33 USERS: [ 'id', 'username', 'createdAt' ],
34 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
35 ACCOUNTS: [ 'createdAt' ],
36 JOBS: [ 'createdAt' ],
37 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
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',
60 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
64 // ---------------------------------------------------------------------------
66 // Number of points we add/remove after a successful/bad request
67 const ACTOR_FOLLOW_SCORE = {
74 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
79 const REMOTE_SCHEME = {
84 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
85 'activitypub-http-broadcast': 5,
86 'activitypub-http-unicast': 5,
87 'activitypub-http-fetcher': 5,
88 'activitypub-follow': 5,
89 'video-file-import': 1,
94 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
95 'activitypub-http-broadcast': 1,
96 'activitypub-http-unicast': 5,
97 'activitypub-http-fetcher': 1,
98 'activitypub-follow': 3,
99 'video-file-import': 1,
104 const JOB_TTL: { [ id in JobType ]: number } = {
105 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
106 'activitypub-http-unicast': 60000 * 10, // 10 minutes
107 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
108 'activitypub-follow': 60000 * 10, // 10 minutes
109 'video-file-import': 1000 * 3600, // 1 hour
110 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
111 'video-import': 1000 * 3600 * 5, // 5 hours
112 'email': 60000 * 10 // 10 minutes
114 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
115 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
116 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
117 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
120 let SCHEDULER_INTERVALS_MS = {
121 badActorFollow: 60000 * 60, // 1 hour
122 removeOldJobs: 60000 * 60, // 1 hour
123 updateVideos: 60000, // 1 minute
124 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
127 // ---------------------------------------------------------------------------
130 CUSTOM_FILE: getLocalConfigFilePath(),
132 PORT: config.get<number>('listen.port'),
133 HOSTNAME: config.get<string>('listen.hostname')
136 DBNAME: 'peertube' + config.get<string>('database.suffix'),
137 HOSTNAME: config.get<string>('database.hostname'),
138 PORT: config.get<number>('database.port'),
139 USERNAME: config.get<string>('database.username'),
140 PASSWORD: config.get<string>('database.password'),
142 MAX: config.get<number>('database.pool.max')
146 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
147 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
148 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
149 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
150 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
153 HOSTNAME: config.get<string>('smtp.hostname'),
154 PORT: config.get<number>('smtp.port'),
155 USERNAME: config.get<string>('smtp.username'),
156 PASSWORD: config.get<string>('smtp.password'),
157 TLS: config.get<boolean>('smtp.tls'),
158 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
159 CA_FILE: config.get<string>('smtp.ca_file'),
160 FROM_ADDRESS: config.get<string>('smtp.from_address')
163 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
164 LOG_DIR: buildPath(config.get<string>('storage.logs')),
165 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
166 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
167 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
168 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
169 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
170 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
173 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
174 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
175 HOSTNAME: config.get<string>('webserver.hostname'),
176 PORT: config.get<number>('webserver.port'),
180 TRUST_PROXY: config.get<string[]>('trust_proxy'),
182 LEVEL: config.get<string>('log.level')
186 USERS: config.get<boolean>('search.remote_uri.users'),
187 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
191 get EMAIL () { return config.get<string>('admin.email') }
194 get ENABLED () { return config.get<boolean>('signup.enabled') },
195 get LIMIT () { return config.get<number>('signup.limit') },
198 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
199 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
204 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
207 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
208 get THREADS () { return config.get<number>('transcoding.threads') },
210 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
211 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
212 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
213 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
214 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
220 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
223 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
229 get SIZE () { return config.get<number>('cache.previews.size') }
232 get SIZE () { return config.get<number>('cache.captions.size') }
236 get NAME () { return config.get<string>('instance.name') },
237 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
238 get DESCRIPTION () { return config.get<string>('instance.description') },
239 get TERMS () { return config.get<string>('instance.terms') },
240 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
241 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
243 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
244 get CSS () { return config.get<string>('instance.customizations.css') }
246 get ROBOTS () { return config.get<string>('instance.robots') }
250 get USERNAME () { return config.get<string>('services.twitter.username') },
251 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
256 // ---------------------------------------------------------------------------
258 const CONSTRAINTS_FIELDS = {
260 NAME: { min: 3, max: 120 }, // Length
261 DESCRIPTION: { min: 3, max: 250 }, // Length
262 USERNAME: { min: 3, max: 20 }, // Length
263 PASSWORD: { min: 6, max: 255 }, // Length
264 VIDEO_QUOTA: { min: -1 },
265 BLOCKED_REASON: { min: 3, max: 250 } // Length
268 REASON: { min: 2, max: 300 }, // Length
269 MODERATION_COMMENT: { min: 2, max: 300 } // Length
272 REASON: { min: 2, max: 300 } // Length
275 NAME: { min: 3, max: 120 }, // Length
276 DESCRIPTION: { min: 3, max: 500 }, // Length
277 SUPPORT: { min: 3, max: 500 }, // Length
278 URL: { min: 3, max: 2000 } // Length
282 EXTNAME: [ '.vtt', '.srt' ],
284 max: 2 * 1024 * 1024 // 2MB
289 URL: { min: 3, max: 2000 }, // Length
290 TORRENT_NAME: { min: 3, max: 255 }, // Length
292 EXTNAME: [ '.torrent' ],
294 max: 1024 * 200 // 200 KB
299 NAME: { min: 3, max: 120 }, // Length
300 LANGUAGE: { min: 1, max: 10 }, // Length
301 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
302 DESCRIPTION: { min: 3, max: 10000 }, // Length
303 SUPPORT: { min: 3, max: 500 }, // Length
305 EXTNAME: [ '.jpg', '.jpeg' ],
307 max: 2 * 1024 * 1024 // 2MB
310 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
311 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
312 DURATION: { min: 0 }, // Number
313 TAGS: { min: 0, max: 5 }, // Number of total tags
314 TAG: { min: 2, max: 30 }, // Length
315 THUMBNAIL: { min: 2, max: 30 },
316 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
319 DISLIKES: { min: 0 },
320 FILE_SIZE: { min: 10 },
321 URL: { min: 3, max: 2000 } // Length
324 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
325 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
326 URL: { min: 3, max: 2000 }, // Length
328 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
330 max: 2 * 1024 * 1024 // 2MB
338 TEXT: { min: 1, max: 3000 }, // Length
339 URL: { min: 3, max: 2000 } // Length
342 URL: { min: 3, max: 2000 } // Length
346 const RATES_LIMIT = {
348 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
349 MAX: 15 // 15 attempts
353 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
354 const VIDEO_TRANSCODING_FPS = {
358 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
361 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
366 const FFMPEG_NICE: { [ id: string ]: number } = {
367 THUMBNAIL: 2, // 2 just for don't blocking servers
371 const VIDEO_CATEGORIES = {
386 15: 'Science & Technology',
392 // See https://creativecommons.org/licenses/?lang=en
393 const VIDEO_LICENCES = {
395 2: 'Attribution - Share Alike',
396 3: 'Attribution - No Derivatives',
397 4: 'Attribution - Non Commercial',
398 5: 'Attribution - Non Commercial - Share Alike',
399 6: 'Attribution - Non Commercial - No Derivatives',
400 7: 'Public Domain Dedication'
403 const VIDEO_LANGUAGES = buildLanguages()
405 const VIDEO_PRIVACIES = {
406 [VideoPrivacy.PUBLIC]: 'Public',
407 [VideoPrivacy.UNLISTED]: 'Unlisted',
408 [VideoPrivacy.PRIVATE]: 'Private'
411 const VIDEO_STATES = {
412 [VideoState.PUBLISHED]: 'Published',
413 [VideoState.TO_TRANSCODE]: 'To transcode',
414 [VideoState.TO_IMPORT]: 'To import'
417 const VIDEO_IMPORT_STATES = {
418 [VideoImportState.FAILED]: 'Failed',
419 [VideoImportState.PENDING]: 'Pending',
420 [VideoImportState.SUCCESS]: 'Success'
423 const VIDEO_ABUSE_STATES = {
424 [VideoAbuseState.PENDING]: 'Pending',
425 [VideoAbuseState.REJECTED]: 'Rejected',
426 [VideoAbuseState.ACCEPTED]: 'Accepted'
429 const VIDEO_MIMETYPE_EXT = {
430 'video/webm': '.webm',
434 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
436 const IMAGE_MIMETYPE_EXT = {
442 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
444 'application/x-subrip': '.srt'
447 const TORRENT_MIMETYPE_EXT = {
448 'application/x-bittorrent': '.torrent'
451 // ---------------------------------------------------------------------------
453 const SERVER_ACTOR_NAME = 'peertube'
455 const ACTIVITY_PUB = {
456 POTENTIAL_ACCEPT_HEADERS: [
457 'application/activity+json',
458 'application/ld+json',
459 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
461 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
462 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
463 COLLECTION_ITEMS_PER_PAGE: 10,
464 FETCH_PAGE_LIMIT: 100,
466 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
467 TORRENT: [ 'application/x-bittorrent' ],
468 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
470 MAX_RECURSION_COMMENTS: 100,
471 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
472 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
475 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
478 APPLICATION: 'Application'
481 // ---------------------------------------------------------------------------
483 const PRIVATE_RSA_KEY_SIZE = 2048
485 // Password encryption
486 const BCRYPT_SALT_SIZE = 10
488 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
490 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
491 DO_NOT_LIST: 'do_not_list',
496 // ---------------------------------------------------------------------------
498 // Express static paths (router)
499 const STATIC_PATHS = {
500 PREVIEWS: '/static/previews/',
501 THUMBNAILS: '/static/thumbnails/',
502 TORRENTS: '/static/torrents/',
503 WEBSEED: '/static/webseed/',
504 AVATARS: '/static/avatars/',
505 VIDEO_CAPTIONS: '/static/video-captions/'
507 const STATIC_DOWNLOAD_PATHS = {
508 TORRENTS: '/download/torrents/',
509 VIDEOS: '/download/videos/'
513 let STATIC_MAX_AGE = '2h'
515 // Videos thumbnail size
516 const THUMBNAILS_SIZE = {
520 const PREVIEWS_SIZE = {
524 const AVATARS_SIZE = {
534 // Sub folders of cache directory
537 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
538 MAX_AGE: 1000 * 3600 * 3 // 3 hours
541 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
542 MAX_AGE: 1000 * 3600 * 3 // 3 hours
546 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
548 // ---------------------------------------------------------------------------
550 const CUSTOM_HTML_TAG_COMMENTS = {
551 TITLE: '<!-- title tag -->',
552 DESCRIPTION: '<!-- description tag -->',
553 CUSTOM_CSS: '<!-- custom css tag -->',
554 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
557 // ---------------------------------------------------------------------------
563 // ---------------------------------------------------------------------------
565 const TRACKER_RATE_LIMITS = {
566 INTERVAL: 60000 * 5, // 5 minutes
567 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
568 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
571 // ---------------------------------------------------------------------------
573 // Special constants for a test instance
574 if (isTestInstance() === true) {
575 ACTOR_FOLLOW_SCORE.BASE = 20
577 REMOTE_SCHEME.HTTP = 'http'
578 REMOTE_SCHEME.WS = 'ws'
582 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
583 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
584 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
586 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
588 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
589 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
590 SCHEDULER_INTERVALS_MS.updateVideos = 5000
592 VIDEO_VIEW_LIFETIME = 1000 // 1 second
594 JOB_ATTEMPTS['email'] = 1
596 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
599 updateWebserverConfig()
601 // ---------------------------------------------------------------------------
605 VIDEO_CAPTIONS_MIMETYPE_EXT,
616 LAST_MIGRATION_VERSION,
618 CUSTOM_HTML_TAG_COMMENTS,
619 BROADCAST_CONCURRENCY,
626 PRIVATE_RSA_KEY_SIZE,
627 ROUTE_CACHE_LIFETIME,
632 TORRENT_MIMETYPE_EXT,
636 ACTIVITY_PUB_ACTOR_TYPES,
645 VIDEO_TRANSCODING_FPS,
649 USER_PASSWORD_RESET_LIFETIME,
651 SCHEDULER_INTERVALS_MS,
652 STATIC_DOWNLOAD_PATHS,
655 CRAWL_REQUEST_CONCURRENCY,
656 JOB_COMPLETED_LIFETIME,
662 // ---------------------------------------------------------------------------
664 function getLocalConfigFilePath () {
665 const configSources = config.util.getConfigSources()
666 if (configSources.length === 0) throw new Error('Invalid config source.')
668 let filename = 'local'
669 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
670 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
672 return join(dirname(configSources[ 0 ].name), filename + '.json')
675 function updateWebserverConfig () {
676 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
677 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
680 function buildLanguages () {
681 const iso639 = require('iso-639-3')
683 const languages: { [ id: string ]: string } = {}
685 const additionalLanguages = {
686 'sgn': true, // Sign languages (macro language)
687 'ase': true, // American sign language
688 'sdl': true, // Arabian sign language
689 'bfi': true, // British sign language
690 'bzs': true, // Brazilian sign language
691 'csl': true, // Chinese sign language
692 'cse': true, // Czech sign language
693 'dsl': true, // Danish sign language
694 'fsl': true, // French sign language
695 'gsg': true, // German sign language
696 'pks': true, // Pakistan sign language
697 'jsl': true, // Japanese sign language
698 'sfs': true, // South African sign language
699 'swl': true, // Swedish sign language
700 'rsl': true, // Russian sign language: true
702 'epo': true, // Esperanto
703 'tlh': true, // Klingon
704 'jbo': true, // Lojban
705 'avk': true // Kotava
708 // Only add ISO639-1 languages and some sign languages (ISO639-3)
711 return (l.iso6391 !== null && l.type === 'living') ||
712 additionalLanguages[l.iso6393] === true
714 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
719 export function reloadConfig () {
721 function directory () {
722 if (process.env.NODE_CONFIG_DIR) {
723 return process.env.NODE_CONFIG_DIR
726 return join(root(), 'config')
730 for (const fileName in require.cache) {
731 if (-1 === fileName.indexOf(directory())) {
735 delete require.cache[fileName]
738 delete require.cache[require.resolve('config')]
743 config = require('config')
745 updateWebserverConfig()