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'
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 = 215
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
24 // Number of results by default for the pagination
25 const PAGINATION_COUNT_DEFAULT = 15
27 // Sortable columns per schema
28 const SORTABLE_COLUMNS = {
29 USERS: [ 'id', 'username', 'createdAt' ],
30 ACCOUNTS: [ 'createdAt' ],
31 JOBS: [ 'createdAt' ],
32 VIDEO_ABUSES: [ 'id', 'createdAt' ],
33 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
34 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
35 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
36 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
37 FOLLOWERS: [ 'createdAt' ],
38 FOLLOWING: [ 'createdAt' ]
41 const OAUTH_LIFETIME = {
42 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
43 REFRESH_TOKEN: 1209600 // 2 weeks
46 const ROUTE_CACHE_LIFETIME = {
47 FEEDS: 1000 * 60 * 15, // 15 minutes
49 VIDEOS: 1000 // 1 second, cache concurrent requests after a broadcast for example
53 // ---------------------------------------------------------------------------
55 // Number of points we add/remove after a successful/bad request
56 const ACTOR_FOLLOW_SCORE = {
63 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
68 const REMOTE_SCHEME = {
73 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
74 'activitypub-http-broadcast': 5,
75 'activitypub-http-unicast': 5,
76 'activitypub-http-fetcher': 5,
77 'activitypub-follow': 5,
78 'video-file-import': 1,
82 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
83 'activitypub-http-broadcast': 1,
84 'activitypub-http-unicast': 5,
85 'activitypub-http-fetcher': 1,
86 'activitypub-follow': 3,
87 'video-file-import': 1,
91 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
92 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
93 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
94 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
97 let SCHEDULER_INTERVAL = 60000 * 60
99 // ---------------------------------------------------------------------------
102 CUSTOM_FILE: getLocalConfigFilePath(),
104 PORT: config.get<number>('listen.port'),
105 HOSTNAME: config.get<string>('listen.hostname')
108 DBNAME: 'peertube' + config.get<string>('database.suffix'),
109 HOSTNAME: config.get<string>('database.hostname'),
110 PORT: config.get<number>('database.port'),
111 USERNAME: config.get<string>('database.username'),
112 PASSWORD: config.get<string>('database.password')
115 HOSTNAME: config.get<string>('redis.hostname'),
116 PORT: config.get<number>('redis.port'),
117 AUTH: config.get<string>('redis.auth'),
118 DB: config.get<number>('redis.db')
121 HOSTNAME: config.get<string>('smtp.hostname'),
122 PORT: config.get<number>('smtp.port'),
123 USERNAME: config.get<string>('smtp.username'),
124 PASSWORD: config.get<string>('smtp.password'),
125 TLS: config.get<boolean>('smtp.tls'),
126 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
127 CA_FILE: config.get<string>('smtp.ca_file'),
128 FROM_ADDRESS: config.get<string>('smtp.from_address')
131 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
132 LOG_DIR: buildPath(config.get<string>('storage.logs')),
133 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
134 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
135 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
136 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
137 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
140 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
141 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
142 HOSTNAME: config.get<string>('webserver.hostname'),
143 PORT: config.get<number>('webserver.port'),
147 TRUST_PROXY: config.get<string[]>('trust_proxy'),
149 LEVEL: config.get<string>('log.level')
152 get EMAIL () { return config.get<string>('admin.email') }
155 get ENABLED () { return config.get<boolean>('signup.enabled') },
156 get LIMIT () { return config.get<number>('signup.limit') },
159 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
160 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
165 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
168 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
169 get THREADS () { return config.get<number>('transcoding.threads') },
171 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
172 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
173 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
174 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
175 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
180 get SIZE () { return config.get<number>('cache.previews.size') }
184 get NAME () { return config.get<string>('instance.name') },
185 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
186 get DESCRIPTION () { return config.get<string>('instance.description') },
187 get TERMS () { return config.get<string>('instance.terms') },
188 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
189 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
191 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
192 get CSS () { return config.get<string>('instance.customizations.css') }
194 get ROBOTS () { return config.get<string>('instance.robots') }
198 get USERNAME () { return config.get<string>('services.twitter.username') },
199 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
204 // ---------------------------------------------------------------------------
206 const CONSTRAINTS_FIELDS = {
208 NAME: { min: 3, max: 120 }, // Length
209 DESCRIPTION: { min: 3, max: 250 }, // Length
210 USERNAME: { min: 3, max: 20 }, // Length
211 PASSWORD: { min: 6, max: 255 }, // Length
212 VIDEO_QUOTA: { min: -1 }
215 REASON: { min: 2, max: 300 } // Length
218 NAME: { min: 3, max: 120 }, // Length
219 DESCRIPTION: { min: 3, max: 500 }, // Length
220 SUPPORT: { min: 3, max: 500 }, // Length
221 URL: { min: 3, max: 2000 } // Length
224 NAME: { min: 3, max: 120 }, // Length
225 LANGUAGE: { min: 1, max: 10 }, // Length
226 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
227 DESCRIPTION: { min: 3, max: 10000 }, // Length
228 SUPPORT: { min: 3, max: 500 }, // Length
230 EXTNAME: [ '.jpg', '.jpeg' ],
232 max: 2 * 1024 * 1024 // 2MB
235 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
236 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
237 DURATION: { min: 1 }, // Number
238 TAGS: { min: 0, max: 5 }, // Number of total tags
239 TAG: { min: 2, max: 30 }, // Length
240 THUMBNAIL: { min: 2, max: 30 },
241 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
244 DISLIKES: { min: 0 },
245 FILE_SIZE: { min: 10 },
246 URL: { min: 3, max: 2000 } // Length
249 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
250 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
251 URL: { min: 3, max: 2000 }, // Length
253 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
255 max: 2 * 1024 * 1024 // 2MB
263 TEXT: { min: 1, max: 3000 }, // Length
264 URL: { min: 3, max: 2000 } // Length
267 URL: { min: 3, max: 2000 } // Length
271 const RATES_LIMIT = {
273 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
274 MAX: 15 // 15 attempts
278 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
279 const VIDEO_TRANSCODING_FPS = {
284 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
289 const VIDEO_CATEGORIES = {
304 15: 'Science & Technology',
310 // See https://creativecommons.org/licenses/?lang=en
311 const VIDEO_LICENCES = {
313 2: 'Attribution - Share Alike',
314 3: 'Attribution - No Derivatives',
315 4: 'Attribution - Non Commercial',
316 5: 'Attribution - Non Commercial - Share Alike',
317 6: 'Attribution - Non Commercial - No Derivatives',
318 7: 'Public Domain Dedication'
321 const VIDEO_LANGUAGES = buildLanguages()
323 const VIDEO_PRIVACIES = {
324 [VideoPrivacy.PUBLIC]: 'Public',
325 [VideoPrivacy.UNLISTED]: 'Unlisted',
326 [VideoPrivacy.PRIVATE]: 'Private'
329 const VIDEO_MIMETYPE_EXT = {
330 'video/webm': '.webm',
334 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
336 const IMAGE_MIMETYPE_EXT = {
342 // ---------------------------------------------------------------------------
344 const SERVER_ACTOR_NAME = 'peertube'
346 const ACTIVITY_PUB = {
347 POTENTIAL_ACCEPT_HEADERS: [
348 'application/activity+json',
349 'application/ld+json',
350 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
352 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
353 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
354 COLLECTION_ITEMS_PER_PAGE: 10,
355 FETCH_PAGE_LIMIT: 100,
357 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
358 TORRENT: [ 'application/x-bittorrent' ],
359 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
361 MAX_RECURSION_COMMENTS: 100,
362 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
365 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
368 APPLICATION: 'Application'
371 // ---------------------------------------------------------------------------
373 const PRIVATE_RSA_KEY_SIZE = 2048
375 // Password encryption
376 const BCRYPT_SALT_SIZE = 10
378 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
380 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
381 DO_NOT_LIST: 'do_not_list',
386 // ---------------------------------------------------------------------------
388 // Express static paths (router)
389 const STATIC_PATHS = {
390 PREVIEWS: '/static/previews/',
391 THUMBNAILS: '/static/thumbnails/',
392 TORRENTS: '/static/torrents/',
393 WEBSEED: '/static/webseed/',
394 AVATARS: '/static/avatars/'
396 const STATIC_DOWNLOAD_PATHS = {
397 TORRENTS: '/download/torrents/',
398 VIDEOS: '/download/videos/'
402 let STATIC_MAX_AGE = '30d'
404 // Videos thumbnail size
405 const THUMBNAILS_SIZE = {
409 const PREVIEWS_SIZE = {
413 const AVATARS_SIZE = {
423 // Sub folders of cache directory
426 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
430 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
432 // ---------------------------------------------------------------------------
434 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
436 // ---------------------------------------------------------------------------
442 // ---------------------------------------------------------------------------
444 // Special constants for a test instance
445 if (isTestInstance() === true) {
446 ACTOR_FOLLOW_SCORE.BASE = 20
447 REMOTE_SCHEME.HTTP = 'http'
448 REMOTE_SCHEME.WS = 'ws'
450 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
451 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
452 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
453 SCHEDULER_INTERVAL = 10000
454 VIDEO_VIEW_LIFETIME = 1000 // 1 second
457 updateWebserverConfig()
459 // ---------------------------------------------------------------------------
472 LAST_MIGRATION_VERSION,
474 OPENGRAPH_AND_OEMBED_COMMENT,
475 BROADCAST_CONCURRENCY,
476 PAGINATION_COUNT_DEFAULT,
482 PRIVATE_RSA_KEY_SIZE,
483 ROUTE_CACHE_LIFETIME,
490 ACTIVITY_PUB_ACTOR_TYPES,
498 VIDEO_TRANSCODING_FPS,
501 USER_PASSWORD_RESET_LIFETIME,
504 STATIC_DOWNLOAD_PATHS,
507 JOB_COMPLETED_LIFETIME,
512 // ---------------------------------------------------------------------------
514 function getLocalConfigFilePath () {
515 const configSources = config.util.getConfigSources()
516 if (configSources.length === 0) throw new Error('Invalid config source.')
518 let filename = 'local'
519 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
520 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
522 return join(dirname(configSources[ 0 ].name), filename + '.json')
525 function updateWebserverConfig () {
526 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
527 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
530 function buildLanguages () {
531 const iso639 = require('iso-639-3')
533 const languages: { [ id: string ]: string } = {}
535 const signLanguages = [
536 'sgn', // Sign languages (macro language)
548 'sfs', // South African
553 // Only add ISO639-1 languages and some sign languages (ISO639-3)
556 return (l.iso6391 !== null && l.type === 'living') ||
557 signLanguages.indexOf(l.iso6393) !== -1
559 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
564 export function reloadConfig () {
566 function directory () {
567 if (process.env.NODE_CONFIG_DIR) {
568 return process.env.NODE_CONFIG_DIR
571 return join(root(), 'config')
575 for (const fileName in require.cache) {
576 if (-1 === fileName.indexOf(directory())) {
580 delete require.cache[fileName]
583 delete require.cache[require.resolve('config')]
588 config = require('config')
590 updateWebserverConfig()