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 = 210
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', '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 // ---------------------------------------------------------------------------
47 // Number of points we add/remove after a successful/bad request
48 const ACTOR_FOLLOW_SCORE = {
55 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
60 const REMOTE_SCHEME = {
65 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
66 'activitypub-http-broadcast': 5,
67 'activitypub-http-unicast': 5,
68 'activitypub-http-fetcher': 5,
69 'activitypub-follow': 5,
73 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
74 'activitypub-http-broadcast': 1,
75 'activitypub-http-unicast': 5,
76 'activitypub-http-fetcher': 1,
77 'activitypub-follow': 3,
81 const BROADCAST_CONCURRENCY = 5 // How many requests in parallel we do in activitypub-http-broadcast job
83 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
86 let SCHEDULER_INTERVAL = 60000 * 60
88 // ---------------------------------------------------------------------------
91 CUSTOM_FILE: getLocalConfigFilePath(),
93 PORT: config.get<number>('listen.port'),
94 HOSTNAME: config.get<string>('listen.hostname')
97 DBNAME: 'peertube' + config.get<string>('database.suffix'),
98 HOSTNAME: config.get<string>('database.hostname'),
99 PORT: config.get<number>('database.port'),
100 USERNAME: config.get<string>('database.username'),
101 PASSWORD: config.get<string>('database.password')
104 HOSTNAME: config.get<string>('redis.hostname'),
105 PORT: config.get<number>('redis.port'),
106 AUTH: config.get<string>('redis.auth')
109 HOSTNAME: config.get<string>('smtp.hostname'),
110 PORT: config.get<number>('smtp.port'),
111 USERNAME: config.get<string>('smtp.username'),
112 PASSWORD: config.get<string>('smtp.password'),
113 TLS: config.get<boolean>('smtp.tls'),
114 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
115 CA_FILE: config.get<string>('smtp.ca_file'),
116 FROM_ADDRESS: config.get<string>('smtp.from_address')
119 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
120 LOG_DIR: buildPath(config.get<string>('storage.logs')),
121 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
122 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
123 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
124 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
125 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
128 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
129 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
130 HOSTNAME: config.get<string>('webserver.hostname'),
131 PORT: config.get<number>('webserver.port'),
135 TRUST_PROXY: config.get<string[]>('trust_proxy'),
137 LEVEL: config.get<string>('log.level')
140 get EMAIL () { return config.get<string>('admin.email') }
143 get ENABLED () { return config.get<boolean>('signup.enabled') },
144 get LIMIT () { return config.get<number>('signup.limit') }
147 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
150 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
151 get THREADS () { return config.get<number>('transcoding.threads') },
153 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
154 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
155 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
156 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
157 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
162 get SIZE () { return config.get<number>('cache.previews.size') }
166 get NAME () { return config.get<string>('instance.name') },
167 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
168 get DESCRIPTION () { return config.get<string>('instance.description') },
169 get TERMS () { return config.get<string>('instance.terms') },
170 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
171 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
173 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
174 get CSS () { return config.get<string>('instance.customizations.css') }
179 // ---------------------------------------------------------------------------
181 const CONSTRAINTS_FIELDS = {
183 USERNAME: { min: 3, max: 20 }, // Length
184 PASSWORD: { min: 6, max: 255 }, // Length
185 DESCRIPTION: { min: 3, max: 250 }, // Length
186 VIDEO_QUOTA: { min: -1 }
189 REASON: { min: 2, max: 300 } // Length
192 NAME: { min: 3, max: 120 }, // Length
193 DESCRIPTION: { min: 3, max: 250 }, // Length
194 SUPPORT: { min: 3, max: 300 }, // Length
195 URL: { min: 3, max: 2000 } // Length
198 NAME: { min: 3, max: 120 }, // Length
199 LANGUAGE: { min: 1, max: 10 }, // Length
200 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
201 DESCRIPTION: { min: 3, max: 10000 }, // Length
202 SUPPORT: { min: 3, max: 300 }, // Length
204 EXTNAME: [ '.jpg', '.jpeg' ],
206 max: 2 * 1024 * 1024 // 2MB
209 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
210 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
211 DURATION: { min: 1 }, // Number
212 TAGS: { min: 0, max: 5 }, // Number of total tags
213 TAG: { min: 2, max: 30 }, // Length
214 THUMBNAIL: { min: 2, max: 30 },
215 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
218 DISLIKES: { min: 0 },
219 FILE_SIZE: { min: 10 },
220 URL: { min: 3, max: 2000 } // Length
223 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
224 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
225 URL: { min: 3, max: 2000 }, // Length
227 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
229 max: 2 * 1024 * 1024 // 2MB
237 TEXT: { min: 1, max: 3000 }, // Length
238 URL: { min: 3, max: 2000 } // Length
241 URL: { min: 3, max: 2000 } // Length
245 const RATES_LIMIT = {
247 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
248 MAX: 15 // 15 attempts
252 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
253 const VIDEO_TRANSCODING_FPS = {
258 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
263 const VIDEO_CATEGORIES = {
278 15: 'Science & Technology',
284 // See https://creativecommons.org/licenses/?lang=en
285 const VIDEO_LICENCES = {
287 2: 'Attribution - Share Alike',
288 3: 'Attribution - No Derivatives',
289 4: 'Attribution - Non Commercial',
290 5: 'Attribution - Non Commercial - Share Alike',
291 6: 'Attribution - Non Commercial - No Derivatives',
292 7: 'Public Domain Dedication'
295 const VIDEO_LANGUAGES = buildLanguages()
297 const VIDEO_PRIVACIES = {
298 [VideoPrivacy.PUBLIC]: 'Public',
299 [VideoPrivacy.UNLISTED]: 'Unlisted',
300 [VideoPrivacy.PRIVATE]: 'Private'
303 const VIDEO_MIMETYPE_EXT = {
304 'video/webm': '.webm',
309 const IMAGE_MIMETYPE_EXT = {
315 // ---------------------------------------------------------------------------
317 const SERVER_ACTOR_NAME = 'peertube'
319 const ACTIVITY_PUB = {
320 POTENTIAL_ACCEPT_HEADERS: [
321 'application/activity+json',
322 'application/ld+json',
323 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
325 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
326 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
327 COLLECTION_ITEMS_PER_PAGE: 10,
328 FETCH_PAGE_LIMIT: 100,
330 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
331 TORRENT: [ 'application/x-bittorrent' ],
332 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
334 MAX_RECURSION_COMMENTS: 100,
335 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
338 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
341 APPLICATION: 'Application'
344 // ---------------------------------------------------------------------------
346 const PRIVATE_RSA_KEY_SIZE = 2048
348 // Password encryption
349 const BCRYPT_SALT_SIZE = 10
351 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
353 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
354 DO_NOT_LIST: 'do_not_list',
359 // ---------------------------------------------------------------------------
361 // Express static paths (router)
362 const STATIC_PATHS = {
363 PREVIEWS: '/static/previews/',
364 THUMBNAILS: '/static/thumbnails/',
365 TORRENTS: '/static/torrents/',
366 WEBSEED: '/static/webseed/',
367 AVATARS: '/static/avatars/'
371 let STATIC_MAX_AGE = '30d'
373 // Videos thumbnail size
374 const THUMBNAILS_SIZE = {
378 const PREVIEWS_SIZE = {
382 const AVATARS_SIZE = {
392 // Sub folders of cache directory
395 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
399 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
401 // ---------------------------------------------------------------------------
403 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
405 // ---------------------------------------------------------------------------
409 CACHE_LIFETIME: 1000 * 60 * 15 // 15 minutes
412 // ---------------------------------------------------------------------------
414 // Special constants for a test instance
415 if (isTestInstance() === true) {
416 ACTOR_FOLLOW_SCORE.BASE = 20
417 REMOTE_SCHEME.HTTP = 'http'
418 REMOTE_SCHEME.WS = 'ws'
420 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
421 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
422 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
423 SCHEDULER_INTERVAL = 10000
424 VIDEO_VIEW_LIFETIME = 1000 // 1 second
427 updateWebserverConfig()
429 // ---------------------------------------------------------------------------
442 LAST_MIGRATION_VERSION,
444 OPENGRAPH_AND_OEMBED_COMMENT,
445 BROADCAST_CONCURRENCY,
446 PAGINATION_COUNT_DEFAULT,
452 PRIVATE_RSA_KEY_SIZE,
459 ACTIVITY_PUB_ACTOR_TYPES,
467 VIDEO_TRANSCODING_FPS,
468 USER_PASSWORD_RESET_LIFETIME,
472 JOB_COMPLETED_LIFETIME,
476 // ---------------------------------------------------------------------------
478 function getLocalConfigFilePath () {
479 const configSources = config.util.getConfigSources()
480 if (configSources.length === 0) throw new Error('Invalid config source.')
482 let filename = 'local'
483 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
484 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
486 return join(dirname(configSources[ 0 ].name), filename + '.json')
489 function updateWebserverConfig () {
490 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
491 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
494 function buildLanguages () {
495 const iso639 = require('iso-639-3')
497 const languages: { [ id: string ]: string } = {}
499 const signLanguages = [
500 'sgn', // Sign languages (macro language)
512 'sfs', // South African
517 // Only add ISO639-1 languages and some sign languages (ISO639-3)
520 return (l.iso6391 !== null && l.type === 'living') ||
521 signLanguages.indexOf(l.iso6393) !== -1
523 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
528 export function reloadConfig () {
530 function directory () {
531 if (process.env.NODE_CONFIG_DIR) {
532 return process.env.NODE_CONFIG_DIR
535 return join(root(), 'config')
539 for (const fileName in require.cache) {
540 if (-1 === fileName.indexOf(directory())) {
544 delete require.cache[fileName]
547 delete require.cache[require.resolve('config')]
552 config = require('config')
554 updateWebserverConfig()