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,
77 'video-file-import': 1,
81 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
82 'activitypub-http-broadcast': 1,
83 'activitypub-http-unicast': 5,
84 'activitypub-http-fetcher': 1,
85 'activitypub-follow': 3,
86 'video-file-import': 1,
90 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
91 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
92 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
93 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
96 let SCHEDULER_INTERVAL = 60000 * 60
98 // ---------------------------------------------------------------------------
101 CUSTOM_FILE: getLocalConfigFilePath(),
103 PORT: config.get<number>('listen.port'),
104 HOSTNAME: config.get<string>('listen.hostname')
107 DBNAME: 'peertube' + config.get<string>('database.suffix'),
108 HOSTNAME: config.get<string>('database.hostname'),
109 PORT: config.get<number>('database.port'),
110 USERNAME: config.get<string>('database.username'),
111 PASSWORD: config.get<string>('database.password')
114 HOSTNAME: config.get<string>('redis.hostname'),
115 PORT: config.get<number>('redis.port'),
116 AUTH: config.get<string>('redis.auth'),
117 DB: config.get<number>('redis.db')
120 HOSTNAME: config.get<string>('smtp.hostname'),
121 PORT: config.get<number>('smtp.port'),
122 USERNAME: config.get<string>('smtp.username'),
123 PASSWORD: config.get<string>('smtp.password'),
124 TLS: config.get<boolean>('smtp.tls'),
125 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
126 CA_FILE: config.get<string>('smtp.ca_file'),
127 FROM_ADDRESS: config.get<string>('smtp.from_address')
130 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
131 LOG_DIR: buildPath(config.get<string>('storage.logs')),
132 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
133 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
134 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
135 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
136 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
139 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
140 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
141 HOSTNAME: config.get<string>('webserver.hostname'),
142 PORT: config.get<number>('webserver.port'),
146 TRUST_PROXY: config.get<string[]>('trust_proxy'),
148 LEVEL: config.get<string>('log.level')
151 get EMAIL () { return config.get<string>('admin.email') }
154 get ENABLED () { return config.get<boolean>('signup.enabled') },
155 get LIMIT () { return config.get<number>('signup.limit') },
158 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
159 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
164 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
167 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
168 get THREADS () { return config.get<number>('transcoding.threads') },
170 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
171 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
172 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
173 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
174 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
179 get SIZE () { return config.get<number>('cache.previews.size') }
183 get NAME () { return config.get<string>('instance.name') },
184 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
185 get DESCRIPTION () { return config.get<string>('instance.description') },
186 get TERMS () { return config.get<string>('instance.terms') },
187 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
188 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
190 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
191 get CSS () { return config.get<string>('instance.customizations.css') }
193 get ROBOTS () { return config.get<string>('instance.robots') }
197 get USERNAME () { return config.get<string>('services.twitter.username') },
198 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
203 // ---------------------------------------------------------------------------
205 const CONSTRAINTS_FIELDS = {
207 NAME: { min: 3, max: 120 }, // Length
208 DESCRIPTION: { min: 3, max: 250 }, // Length
209 USERNAME: { min: 3, max: 20 }, // Length
210 PASSWORD: { min: 6, max: 255 }, // Length
211 VIDEO_QUOTA: { min: -1 }
214 REASON: { min: 2, max: 300 } // Length
217 NAME: { min: 3, max: 120 }, // Length
218 DESCRIPTION: { min: 3, max: 500 }, // Length
219 SUPPORT: { min: 3, max: 500 }, // Length
220 URL: { min: 3, max: 2000 } // Length
223 NAME: { min: 3, max: 120 }, // Length
224 LANGUAGE: { min: 1, max: 10 }, // Length
225 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
226 DESCRIPTION: { min: 3, max: 10000 }, // Length
227 SUPPORT: { min: 3, max: 500 }, // Length
229 EXTNAME: [ '.jpg', '.jpeg' ],
231 max: 2 * 1024 * 1024 // 2MB
234 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
235 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
236 DURATION: { min: 1 }, // Number
237 TAGS: { min: 0, max: 5 }, // Number of total tags
238 TAG: { min: 2, max: 30 }, // Length
239 THUMBNAIL: { min: 2, max: 30 },
240 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
243 DISLIKES: { min: 0 },
244 FILE_SIZE: { min: 10 },
245 URL: { min: 3, max: 2000 } // Length
248 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
249 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
250 URL: { min: 3, max: 2000 }, // Length
252 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
254 max: 2 * 1024 * 1024 // 2MB
262 TEXT: { min: 1, max: 3000 }, // Length
263 URL: { min: 3, max: 2000 } // Length
266 URL: { min: 3, max: 2000 } // Length
270 const RATES_LIMIT = {
272 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
273 MAX: 15 // 15 attempts
277 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
278 const VIDEO_TRANSCODING_FPS = {
283 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
288 const VIDEO_CATEGORIES = {
303 15: 'Science & Technology',
309 // See https://creativecommons.org/licenses/?lang=en
310 const VIDEO_LICENCES = {
312 2: 'Attribution - Share Alike',
313 3: 'Attribution - No Derivatives',
314 4: 'Attribution - Non Commercial',
315 5: 'Attribution - Non Commercial - Share Alike',
316 6: 'Attribution - Non Commercial - No Derivatives',
317 7: 'Public Domain Dedication'
320 const VIDEO_LANGUAGES = buildLanguages()
322 const VIDEO_PRIVACIES = {
323 [VideoPrivacy.PUBLIC]: 'Public',
324 [VideoPrivacy.UNLISTED]: 'Unlisted',
325 [VideoPrivacy.PRIVATE]: 'Private'
328 const VIDEO_MIMETYPE_EXT = {
329 'video/webm': '.webm',
334 const IMAGE_MIMETYPE_EXT = {
340 // ---------------------------------------------------------------------------
342 const SERVER_ACTOR_NAME = 'peertube'
344 const ACTIVITY_PUB = {
345 POTENTIAL_ACCEPT_HEADERS: [
346 'application/activity+json',
347 'application/ld+json',
348 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
350 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
351 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
352 COLLECTION_ITEMS_PER_PAGE: 10,
353 FETCH_PAGE_LIMIT: 100,
355 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
356 TORRENT: [ 'application/x-bittorrent' ],
357 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
359 MAX_RECURSION_COMMENTS: 100,
360 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
363 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
366 APPLICATION: 'Application'
369 // ---------------------------------------------------------------------------
371 const PRIVATE_RSA_KEY_SIZE = 2048
373 // Password encryption
374 const BCRYPT_SALT_SIZE = 10
376 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
378 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
379 DO_NOT_LIST: 'do_not_list',
384 // ---------------------------------------------------------------------------
386 // Express static paths (router)
387 const STATIC_PATHS = {
388 PREVIEWS: '/static/previews/',
389 THUMBNAILS: '/static/thumbnails/',
390 TORRENTS: '/static/torrents/',
391 WEBSEED: '/static/webseed/',
392 AVATARS: '/static/avatars/'
394 const STATIC_DOWNLOAD_PATHS = {
395 TORRENTS: '/download/torrents/',
396 VIDEOS: '/download/videos/'
400 let STATIC_MAX_AGE = '30d'
402 // Videos thumbnail size
403 const THUMBNAILS_SIZE = {
407 const PREVIEWS_SIZE = {
411 const AVATARS_SIZE = {
421 // Sub folders of cache directory
424 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
428 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
430 // ---------------------------------------------------------------------------
432 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
434 // ---------------------------------------------------------------------------
440 // ---------------------------------------------------------------------------
442 // Special constants for a test instance
443 if (isTestInstance() === true) {
444 ACTOR_FOLLOW_SCORE.BASE = 20
445 REMOTE_SCHEME.HTTP = 'http'
446 REMOTE_SCHEME.WS = 'ws'
448 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
449 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
450 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
451 SCHEDULER_INTERVAL = 10000
452 VIDEO_VIEW_LIFETIME = 1000 // 1 second
455 updateWebserverConfig()
457 // ---------------------------------------------------------------------------
470 LAST_MIGRATION_VERSION,
472 OPENGRAPH_AND_OEMBED_COMMENT,
473 BROADCAST_CONCURRENCY,
474 PAGINATION_COUNT_DEFAULT,
480 PRIVATE_RSA_KEY_SIZE,
481 ROUTE_CACHE_LIFETIME,
488 ACTIVITY_PUB_ACTOR_TYPES,
496 VIDEO_TRANSCODING_FPS,
499 USER_PASSWORD_RESET_LIFETIME,
502 STATIC_DOWNLOAD_PATHS,
504 JOB_COMPLETED_LIFETIME,
509 // ---------------------------------------------------------------------------
511 function getLocalConfigFilePath () {
512 const configSources = config.util.getConfigSources()
513 if (configSources.length === 0) throw new Error('Invalid config source.')
515 let filename = 'local'
516 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
517 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
519 return join(dirname(configSources[ 0 ].name), filename + '.json')
522 function updateWebserverConfig () {
523 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
524 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
527 function buildLanguages () {
528 const iso639 = require('iso-639-3')
530 const languages: { [ id: string ]: string } = {}
532 const signLanguages = [
533 'sgn', // Sign languages (macro language)
545 'sfs', // South African
550 // Only add ISO639-1 languages and some sign languages (ISO639-3)
553 return (l.iso6391 !== null && l.type === 'living') ||
554 signLanguages.indexOf(l.iso6393) !== -1
556 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
561 export function reloadConfig () {
563 function directory () {
564 if (process.env.NODE_CONFIG_DIR) {
565 return process.env.NODE_CONFIG_DIR
568 return join(root(), 'config')
572 for (const fileName in require.cache) {
573 if (-1 === fileName.indexOf(directory())) {
577 delete require.cache[fileName]
580 delete require.cache[require.resolve('config')]
585 config = require('config')
587 updateWebserverConfig()