1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType } from '../../shared/models'
4 import { ActivityPubActorType } from '../../shared/models/activitypub'
5 import { FollowState } from '../../shared/models/actors'
6 import { 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'
11 // Use a variable to reload the configuration if we need
12 let config: IConfig = require('config')
14 // ---------------------------------------------------------------------------
16 const LAST_MIGRATION_VERSION = 215
18 // ---------------------------------------------------------------------------
21 const API_VERSION = 'v1'
23 // Number of results by default for the pagination
24 const PAGINATION_COUNT_DEFAULT = 15
26 // Sortable columns per schema
27 const SORTABLE_COLUMNS = {
28 USERS: [ 'id', 'username', 'createdAt' ],
29 ACCOUNTS: [ 'createdAt' ],
30 JOBS: [ 'createdAt' ],
31 VIDEO_ABUSES: [ 'id', 'createdAt' ],
32 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
33 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
34 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
35 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
36 FOLLOWERS: [ 'createdAt' ],
37 FOLLOWING: [ 'createdAt' ]
40 const OAUTH_LIFETIME = {
41 ACCESS_TOKEN: 3600 * 4, // 4 hours
42 REFRESH_TOKEN: 1209600 // 2 weeks
45 const ROUTE_CACHE_LIFETIME = {
46 FEEDS: 1000 * 60 * 15, // 15 minutes
48 VIDEOS: 1000 // 1 second, cache concurrent requests after a broadcast for example
52 // ---------------------------------------------------------------------------
54 // Number of points we add/remove after a successful/bad request
55 const ACTOR_FOLLOW_SCORE = {
62 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
67 const REMOTE_SCHEME = {
72 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
73 'activitypub-http-broadcast': 5,
74 'activitypub-http-unicast': 5,
75 'activitypub-http-fetcher': 5,
76 'activitypub-follow': 5,
80 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
81 'activitypub-http-broadcast': 1,
82 'activitypub-http-unicast': 5,
83 'activitypub-http-fetcher': 1,
84 'activitypub-follow': 3,
88 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
89 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
90 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
91 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
94 let SCHEDULER_INTERVAL = 60000 * 60
96 // ---------------------------------------------------------------------------
99 CUSTOM_FILE: getLocalConfigFilePath(),
101 PORT: config.get<number>('listen.port'),
102 HOSTNAME: config.get<string>('listen.hostname')
105 DBNAME: 'peertube' + config.get<string>('database.suffix'),
106 HOSTNAME: config.get<string>('database.hostname'),
107 PORT: config.get<number>('database.port'),
108 USERNAME: config.get<string>('database.username'),
109 PASSWORD: config.get<string>('database.password')
112 HOSTNAME: config.get<string>('redis.hostname'),
113 PORT: config.get<number>('redis.port'),
114 AUTH: config.get<string>('redis.auth'),
115 DB: config.get<number>('redis.db')
118 HOSTNAME: config.get<string>('smtp.hostname'),
119 PORT: config.get<number>('smtp.port'),
120 USERNAME: config.get<string>('smtp.username'),
121 PASSWORD: config.get<string>('smtp.password'),
122 TLS: config.get<boolean>('smtp.tls'),
123 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
124 CA_FILE: config.get<string>('smtp.ca_file'),
125 FROM_ADDRESS: config.get<string>('smtp.from_address')
128 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
129 LOG_DIR: buildPath(config.get<string>('storage.logs')),
130 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
131 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
132 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
133 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
134 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
137 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
138 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
139 HOSTNAME: config.get<string>('webserver.hostname'),
140 PORT: config.get<number>('webserver.port'),
144 TRUST_PROXY: config.get<string[]>('trust_proxy'),
146 LEVEL: config.get<string>('log.level')
149 get EMAIL () { return config.get<string>('admin.email') }
152 get ENABLED () { return config.get<boolean>('signup.enabled') },
153 get LIMIT () { return config.get<number>('signup.limit') },
156 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
157 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
162 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
165 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
166 get THREADS () { return config.get<number>('transcoding.threads') },
168 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
169 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
170 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
171 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
172 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
177 get SIZE () { return config.get<number>('cache.previews.size') }
181 get NAME () { return config.get<string>('instance.name') },
182 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
183 get DESCRIPTION () { return config.get<string>('instance.description') },
184 get TERMS () { return config.get<string>('instance.terms') },
185 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
186 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
188 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
189 get CSS () { return config.get<string>('instance.customizations.css') }
191 get ROBOTS () { return config.get<string>('instance.robots') }
195 get USERNAME () { return config.get<string>('services.twitter.username') },
196 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
201 // ---------------------------------------------------------------------------
203 const CONSTRAINTS_FIELDS = {
205 NAME: { min: 3, max: 120 }, // Length
206 DESCRIPTION: { min: 3, max: 250 }, // Length
207 USERNAME: { min: 3, max: 20 }, // Length
208 PASSWORD: { min: 6, max: 255 }, // Length
209 VIDEO_QUOTA: { min: -1 }
212 REASON: { min: 2, max: 300 } // Length
215 NAME: { min: 3, max: 120 }, // Length
216 DESCRIPTION: { min: 3, max: 500 }, // Length
217 SUPPORT: { min: 3, max: 500 }, // Length
218 URL: { min: 3, max: 2000 } // Length
221 NAME: { min: 3, max: 120 }, // Length
222 LANGUAGE: { min: 1, max: 10 }, // Length
223 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
224 DESCRIPTION: { min: 3, max: 10000 }, // Length
225 SUPPORT: { min: 3, max: 500 }, // Length
227 EXTNAME: [ '.jpg', '.jpeg' ],
229 max: 2 * 1024 * 1024 // 2MB
232 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
233 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
234 DURATION: { min: 1 }, // Number
235 TAGS: { min: 0, max: 5 }, // Number of total tags
236 TAG: { min: 2, max: 30 }, // Length
237 THUMBNAIL: { min: 2, max: 30 },
238 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
241 DISLIKES: { min: 0 },
242 FILE_SIZE: { min: 10 },
243 URL: { min: 3, max: 2000 } // Length
246 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
247 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
248 URL: { min: 3, max: 2000 }, // Length
250 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
252 max: 2 * 1024 * 1024 // 2MB
260 TEXT: { min: 1, max: 3000 }, // Length
261 URL: { min: 3, max: 2000 } // Length
264 URL: { min: 3, max: 2000 } // Length
268 const RATES_LIMIT = {
270 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
271 MAX: 15 // 15 attempts
275 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
276 const VIDEO_TRANSCODING_FPS = {
281 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
286 const VIDEO_CATEGORIES = {
301 15: 'Science & Technology',
307 // See https://creativecommons.org/licenses/?lang=en
308 const VIDEO_LICENCES = {
310 2: 'Attribution - Share Alike',
311 3: 'Attribution - No Derivatives',
312 4: 'Attribution - Non Commercial',
313 5: 'Attribution - Non Commercial - Share Alike',
314 6: 'Attribution - Non Commercial - No Derivatives',
315 7: 'Public Domain Dedication'
318 const VIDEO_LANGUAGES = buildLanguages()
320 const VIDEO_PRIVACIES = {
321 [VideoPrivacy.PUBLIC]: 'Public',
322 [VideoPrivacy.UNLISTED]: 'Unlisted',
323 [VideoPrivacy.PRIVATE]: 'Private'
326 const VIDEO_MIMETYPE_EXT = {
327 'video/webm': '.webm',
332 const IMAGE_MIMETYPE_EXT = {
338 // ---------------------------------------------------------------------------
340 const SERVER_ACTOR_NAME = 'peertube'
342 const ACTIVITY_PUB = {
343 POTENTIAL_ACCEPT_HEADERS: [
344 'application/activity+json',
345 'application/ld+json',
346 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
348 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
349 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
350 COLLECTION_ITEMS_PER_PAGE: 10,
351 FETCH_PAGE_LIMIT: 100,
353 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
354 TORRENT: [ 'application/x-bittorrent' ],
355 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
357 MAX_RECURSION_COMMENTS: 100,
358 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
361 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
364 APPLICATION: 'Application'
367 // ---------------------------------------------------------------------------
369 const PRIVATE_RSA_KEY_SIZE = 2048
371 // Password encryption
372 const BCRYPT_SALT_SIZE = 10
374 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
376 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
377 DO_NOT_LIST: 'do_not_list',
382 // ---------------------------------------------------------------------------
384 // Express static paths (router)
385 const STATIC_PATHS = {
386 PREVIEWS: '/static/previews/',
387 THUMBNAILS: '/static/thumbnails/',
388 TORRENTS: '/static/torrents/',
389 WEBSEED: '/static/webseed/',
390 AVATARS: '/static/avatars/'
392 const STATIC_DOWNLOAD_PATHS = {
393 TORRENTS: '/download/torrents/',
394 VIDEOS: '/download/videos/'
398 let STATIC_MAX_AGE = '30d'
400 // Videos thumbnail size
401 const THUMBNAILS_SIZE = {
405 const PREVIEWS_SIZE = {
409 const AVATARS_SIZE = {
419 // Sub folders of cache directory
422 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
426 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
428 // ---------------------------------------------------------------------------
430 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
432 // ---------------------------------------------------------------------------
438 // ---------------------------------------------------------------------------
440 // Special constants for a test instance
441 if (isTestInstance() === true) {
442 ACTOR_FOLLOW_SCORE.BASE = 20
443 REMOTE_SCHEME.HTTP = 'http'
444 REMOTE_SCHEME.WS = 'ws'
446 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
447 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
448 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
449 SCHEDULER_INTERVAL = 10000
450 VIDEO_VIEW_LIFETIME = 1000 // 1 second
453 updateWebserverConfig()
455 // ---------------------------------------------------------------------------
468 LAST_MIGRATION_VERSION,
470 OPENGRAPH_AND_OEMBED_COMMENT,
471 BROADCAST_CONCURRENCY,
472 PAGINATION_COUNT_DEFAULT,
478 PRIVATE_RSA_KEY_SIZE,
479 ROUTE_CACHE_LIFETIME,
486 ACTIVITY_PUB_ACTOR_TYPES,
494 VIDEO_TRANSCODING_FPS,
497 USER_PASSWORD_RESET_LIFETIME,
500 STATIC_DOWNLOAD_PATHS,
502 JOB_COMPLETED_LIFETIME,
507 // ---------------------------------------------------------------------------
509 function getLocalConfigFilePath () {
510 const configSources = config.util.getConfigSources()
511 if (configSources.length === 0) throw new Error('Invalid config source.')
513 let filename = 'local'
514 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
515 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
517 return join(dirname(configSources[ 0 ].name), filename + '.json')
520 function updateWebserverConfig () {
521 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
522 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
525 function buildLanguages () {
526 const iso639 = require('iso-639-3')
528 const languages: { [ id: string ]: string } = {}
530 const signLanguages = [
531 'sgn', // Sign languages (macro language)
543 'sfs', // South African
548 // Only add ISO639-1 languages and some sign languages (ISO639-3)
551 return (l.iso6391 !== null && l.type === 'living') ||
552 signLanguages.indexOf(l.iso6393) !== -1
554 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
559 export function reloadConfig () {
561 function directory () {
562 if (process.env.NODE_CONFIG_DIR) {
563 return process.env.NODE_CONFIG_DIR
566 return join(root(), 'config')
570 for (const fileName in require.cache) {
571 if (-1 === fileName.indexOf(directory())) {
575 delete require.cache[fileName]
578 delete require.cache[require.resolve('config')]
583 config = require('config')
585 updateWebserverConfig()