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 ACCOUNTS: [ 'createdAt' ],
35 JOBS: [ 'createdAt' ],
36 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
37 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
38 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
39 VIDEO_IMPORTS: [ 'createdAt' ],
40 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
41 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
42 FOLLOWERS: [ 'createdAt' ],
43 FOLLOWING: [ 'createdAt' ],
45 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ]
48 const OAUTH_LIFETIME = {
49 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
50 REFRESH_TOKEN: 1209600 // 2 weeks
53 const ROUTE_CACHE_LIFETIME = {
56 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 JOB_TTL: { [ id in JobType ]: number } = {
104 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
105 'activitypub-http-unicast': 60000 * 10, // 10 minutes
106 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
107 'activitypub-follow': 60000 * 10, // 10 minutes
108 'video-file-import': 1000 * 3600, // 1 hour
109 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
110 'video-import': 1000 * 3600 * 5, // 5 hours
111 'email': 60000 * 10 // 10 minutes
113 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
114 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
115 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
118 let SCHEDULER_INTERVALS_MS = {
119 badActorFollow: 60000 * 60, // 1 hour
120 removeOldJobs: 60000 * 60, // 1 hour
121 updateVideos: 60000, // 1 minute
122 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
125 // ---------------------------------------------------------------------------
128 CUSTOM_FILE: getLocalConfigFilePath(),
130 PORT: config.get<number>('listen.port'),
131 HOSTNAME: config.get<string>('listen.hostname')
134 DBNAME: 'peertube' + config.get<string>('database.suffix'),
135 HOSTNAME: config.get<string>('database.hostname'),
136 PORT: config.get<number>('database.port'),
137 USERNAME: config.get<string>('database.username'),
138 PASSWORD: config.get<string>('database.password'),
140 MAX: config.get<number>('database.pool.max')
144 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
145 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
146 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
147 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
148 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
151 HOSTNAME: config.get<string>('smtp.hostname'),
152 PORT: config.get<number>('smtp.port'),
153 USERNAME: config.get<string>('smtp.username'),
154 PASSWORD: config.get<string>('smtp.password'),
155 TLS: config.get<boolean>('smtp.tls'),
156 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
157 CA_FILE: config.get<string>('smtp.ca_file'),
158 FROM_ADDRESS: config.get<string>('smtp.from_address')
161 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
162 LOG_DIR: buildPath(config.get<string>('storage.logs')),
163 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
164 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
165 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
166 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
167 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
168 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
171 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
172 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
173 HOSTNAME: config.get<string>('webserver.hostname'),
174 PORT: config.get<number>('webserver.port'),
178 TRUST_PROXY: config.get<string[]>('trust_proxy'),
180 LEVEL: config.get<string>('log.level')
183 get EMAIL () { return config.get<string>('admin.email') }
186 get ENABLED () { return config.get<boolean>('signup.enabled') },
187 get LIMIT () { return config.get<number>('signup.limit') },
190 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
191 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
196 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
199 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
200 get THREADS () { return config.get<number>('transcoding.threads') },
202 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
203 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
204 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
205 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
206 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
212 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
215 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
221 get SIZE () { return config.get<number>('cache.previews.size') }
224 get SIZE () { return config.get<number>('cache.captions.size') }
228 get NAME () { return config.get<string>('instance.name') },
229 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
230 get DESCRIPTION () { return config.get<string>('instance.description') },
231 get TERMS () { return config.get<string>('instance.terms') },
232 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
233 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
235 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
236 get CSS () { return config.get<string>('instance.customizations.css') }
238 get ROBOTS () { return config.get<string>('instance.robots') }
242 get USERNAME () { return config.get<string>('services.twitter.username') },
243 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
248 // ---------------------------------------------------------------------------
250 const CONSTRAINTS_FIELDS = {
252 NAME: { min: 3, max: 120 }, // Length
253 DESCRIPTION: { min: 3, max: 250 }, // Length
254 USERNAME: { min: 3, max: 20 }, // Length
255 PASSWORD: { min: 6, max: 255 }, // Length
256 VIDEO_QUOTA: { min: -1 },
257 BLOCKED_REASON: { min: 3, max: 250 } // Length
260 REASON: { min: 2, max: 300 }, // Length
261 MODERATION_COMMENT: { min: 2, max: 300 } // Length
264 REASON: { min: 2, max: 300 } // Length
267 NAME: { min: 3, max: 120 }, // Length
268 DESCRIPTION: { min: 3, max: 500 }, // Length
269 SUPPORT: { min: 3, max: 500 }, // Length
270 URL: { min: 3, max: 2000 } // Length
274 EXTNAME: [ '.vtt', '.srt' ],
276 max: 2 * 1024 * 1024 // 2MB
281 URL: { min: 3, max: 2000 }, // Length
282 TORRENT_NAME: { min: 3, max: 255 }, // Length
284 EXTNAME: [ '.torrent' ],
286 max: 1024 * 200 // 200 KB
291 NAME: { min: 3, max: 120 }, // Length
292 LANGUAGE: { min: 1, max: 10 }, // Length
293 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
294 DESCRIPTION: { min: 3, max: 10000 }, // Length
295 SUPPORT: { min: 3, max: 500 }, // Length
297 EXTNAME: [ '.jpg', '.jpeg' ],
299 max: 2 * 1024 * 1024 // 2MB
302 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
303 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
304 DURATION: { min: 0 }, // Number
305 TAGS: { min: 0, max: 5 }, // Number of total tags
306 TAG: { min: 2, max: 30 }, // Length
307 THUMBNAIL: { min: 2, max: 30 },
308 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
311 DISLIKES: { min: 0 },
312 FILE_SIZE: { min: 10 },
313 URL: { min: 3, max: 2000 } // Length
316 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
317 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
318 URL: { min: 3, max: 2000 }, // Length
320 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
322 max: 2 * 1024 * 1024 // 2MB
330 TEXT: { min: 1, max: 3000 }, // Length
331 URL: { min: 3, max: 2000 } // Length
334 URL: { min: 3, max: 2000 } // Length
338 const RATES_LIMIT = {
340 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
341 MAX: 15 // 15 attempts
345 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
346 const VIDEO_TRANSCODING_FPS = {
350 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
353 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
358 const FFMPEG_NICE: { [ id: string ]: number } = {
359 THUMBNAIL: 2, // 2 just for don't blocking servers
363 const VIDEO_CATEGORIES = {
378 15: 'Science & Technology',
384 // See https://creativecommons.org/licenses/?lang=en
385 const VIDEO_LICENCES = {
387 2: 'Attribution - Share Alike',
388 3: 'Attribution - No Derivatives',
389 4: 'Attribution - Non Commercial',
390 5: 'Attribution - Non Commercial - Share Alike',
391 6: 'Attribution - Non Commercial - No Derivatives',
392 7: 'Public Domain Dedication'
395 const VIDEO_LANGUAGES = buildLanguages()
397 const VIDEO_PRIVACIES = {
398 [VideoPrivacy.PUBLIC]: 'Public',
399 [VideoPrivacy.UNLISTED]: 'Unlisted',
400 [VideoPrivacy.PRIVATE]: 'Private'
403 const VIDEO_STATES = {
404 [VideoState.PUBLISHED]: 'Published',
405 [VideoState.TO_TRANSCODE]: 'To transcode',
406 [VideoState.TO_IMPORT]: 'To import'
409 const VIDEO_IMPORT_STATES = {
410 [VideoImportState.FAILED]: 'Failed',
411 [VideoImportState.PENDING]: 'Pending',
412 [VideoImportState.SUCCESS]: 'Success'
415 const VIDEO_ABUSE_STATES = {
416 [VideoAbuseState.PENDING]: 'Pending',
417 [VideoAbuseState.REJECTED]: 'Rejected',
418 [VideoAbuseState.ACCEPTED]: 'Accepted'
421 const VIDEO_MIMETYPE_EXT = {
422 'video/webm': '.webm',
426 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
428 const IMAGE_MIMETYPE_EXT = {
434 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
436 'application/x-subrip': '.srt'
439 const TORRENT_MIMETYPE_EXT = {
440 'application/x-bittorrent': '.torrent'
443 // ---------------------------------------------------------------------------
445 const SERVER_ACTOR_NAME = 'peertube'
447 const ACTIVITY_PUB = {
448 POTENTIAL_ACCEPT_HEADERS: [
449 'application/activity+json',
450 'application/ld+json',
451 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
453 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
454 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
455 COLLECTION_ITEMS_PER_PAGE: 10,
456 FETCH_PAGE_LIMIT: 100,
458 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
459 TORRENT: [ 'application/x-bittorrent' ],
460 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
462 MAX_RECURSION_COMMENTS: 100,
463 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
466 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
469 APPLICATION: 'Application'
472 // ---------------------------------------------------------------------------
474 const PRIVATE_RSA_KEY_SIZE = 2048
476 // Password encryption
477 const BCRYPT_SALT_SIZE = 10
479 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
481 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
482 DO_NOT_LIST: 'do_not_list',
487 // ---------------------------------------------------------------------------
489 // Express static paths (router)
490 const STATIC_PATHS = {
491 PREVIEWS: '/static/previews/',
492 THUMBNAILS: '/static/thumbnails/',
493 TORRENTS: '/static/torrents/',
494 WEBSEED: '/static/webseed/',
495 AVATARS: '/static/avatars/',
496 VIDEO_CAPTIONS: '/static/video-captions/'
498 const STATIC_DOWNLOAD_PATHS = {
499 TORRENTS: '/download/torrents/',
500 VIDEOS: '/download/videos/'
504 let STATIC_MAX_AGE = '2h'
506 // Videos thumbnail size
507 const THUMBNAILS_SIZE = {
511 const PREVIEWS_SIZE = {
515 const AVATARS_SIZE = {
525 // Sub folders of cache directory
528 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
529 MAX_AGE: 1000 * 3600 * 3 // 3 hours
532 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
533 MAX_AGE: 1000 * 3600 * 3 // 3 hours
537 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
539 // ---------------------------------------------------------------------------
541 const CUSTOM_HTML_TAG_COMMENTS = {
542 TITLE: '<!-- title tag -->',
543 DESCRIPTION: '<!-- description tag -->',
544 CUSTOM_CSS: '<!-- custom css tag -->',
545 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
548 // ---------------------------------------------------------------------------
554 // ---------------------------------------------------------------------------
556 const TRACKER_RATE_LIMITS = {
557 INTERVAL: 60000 * 5, // 5 minutes
558 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
559 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
562 // ---------------------------------------------------------------------------
564 // Special constants for a test instance
565 if (isTestInstance() === true) {
566 ACTOR_FOLLOW_SCORE.BASE = 20
568 REMOTE_SCHEME.HTTP = 'http'
569 REMOTE_SCHEME.WS = 'ws'
573 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
574 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
576 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
578 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
579 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
580 SCHEDULER_INTERVALS_MS.updateVideos = 5000
582 VIDEO_VIEW_LIFETIME = 1000 // 1 second
584 JOB_ATTEMPTS['email'] = 1
586 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
589 updateWebserverConfig()
591 // ---------------------------------------------------------------------------
595 VIDEO_CAPTIONS_MIMETYPE_EXT,
606 LAST_MIGRATION_VERSION,
608 CUSTOM_HTML_TAG_COMMENTS,
609 BROADCAST_CONCURRENCY,
616 PRIVATE_RSA_KEY_SIZE,
617 ROUTE_CACHE_LIFETIME,
622 TORRENT_MIMETYPE_EXT,
626 ACTIVITY_PUB_ACTOR_TYPES,
635 VIDEO_TRANSCODING_FPS,
639 USER_PASSWORD_RESET_LIFETIME,
641 SCHEDULER_INTERVALS_MS,
642 STATIC_DOWNLOAD_PATHS,
645 JOB_COMPLETED_LIFETIME,
651 // ---------------------------------------------------------------------------
653 function getLocalConfigFilePath () {
654 const configSources = config.util.getConfigSources()
655 if (configSources.length === 0) throw new Error('Invalid config source.')
657 let filename = 'local'
658 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
659 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
661 return join(dirname(configSources[ 0 ].name), filename + '.json')
664 function updateWebserverConfig () {
665 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
666 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
669 function buildLanguages () {
670 const iso639 = require('iso-639-3')
672 const languages: { [ id: string ]: string } = {}
674 const additionalLanguages = {
675 'sgn': true, // Sign languages (macro language)
676 'ase': true, // American sign language
677 'sdl': true, // Arabian sign language
678 'bfi': true, // British sign language
679 'bzs': true, // Brazilian sign language
680 'csl': true, // Chinese sign language
681 'cse': true, // Czech sign language
682 'dsl': true, // Danish sign language
683 'fsl': true, // French sign language
684 'gsg': true, // German sign language
685 'pks': true, // Pakistan sign language
686 'jsl': true, // Japanese sign language
687 'sfs': true, // South African sign language
688 'swl': true, // Swedish sign language
689 'rsl': true, // Russian sign language: true
691 'epo': true, // Esperanto
692 'tlh': true, // Klingon
693 'jbo': true, // Lojban
694 'avk': true // Kotava
697 // Only add ISO639-1 languages and some sign languages (ISO639-3)
700 return (l.iso6391 !== null && l.type === 'living') ||
701 additionalLanguages[l.iso6393] === true
703 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
708 export function reloadConfig () {
710 function directory () {
711 if (process.env.NODE_CONFIG_DIR) {
712 return process.env.NODE_CONFIG_DIR
715 return join(root(), 'config')
719 for (const fileName in require.cache) {
720 if (-1 === fileName.indexOf(directory())) {
724 delete require.cache[fileName]
727 delete require.cache[require.resolve('config')]
732 config = require('config')
734 updateWebserverConfig()