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')
117 HOSTNAME: config.get<string>('smtp.hostname'),
118 PORT: config.get<number>('smtp.port'),
119 USERNAME: config.get<string>('smtp.username'),
120 PASSWORD: config.get<string>('smtp.password'),
121 TLS: config.get<boolean>('smtp.tls'),
122 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
123 CA_FILE: config.get<string>('smtp.ca_file'),
124 FROM_ADDRESS: config.get<string>('smtp.from_address')
127 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
128 LOG_DIR: buildPath(config.get<string>('storage.logs')),
129 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
130 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
131 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
132 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
133 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
136 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
137 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
138 HOSTNAME: config.get<string>('webserver.hostname'),
139 PORT: config.get<number>('webserver.port'),
143 TRUST_PROXY: config.get<string[]>('trust_proxy'),
145 LEVEL: config.get<string>('log.level')
148 get EMAIL () { return config.get<string>('admin.email') }
151 get ENABLED () { return config.get<boolean>('signup.enabled') },
152 get LIMIT () { return config.get<number>('signup.limit') }
155 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
158 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
159 get THREADS () { return config.get<number>('transcoding.threads') },
161 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
162 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
163 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
164 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
165 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
170 get SIZE () { return config.get<number>('cache.previews.size') }
174 get NAME () { return config.get<string>('instance.name') },
175 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
176 get DESCRIPTION () { return config.get<string>('instance.description') },
177 get TERMS () { return config.get<string>('instance.terms') },
178 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
179 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
181 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
182 get CSS () { return config.get<string>('instance.customizations.css') }
187 get USERNAME () { return config.get<string>('services.twitter.username') },
188 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
193 // ---------------------------------------------------------------------------
195 const CONSTRAINTS_FIELDS = {
197 NAME: { min: 3, max: 120 }, // Length
198 DESCRIPTION: { min: 3, max: 250 }, // Length
199 USERNAME: { min: 3, max: 20 }, // Length
200 PASSWORD: { min: 6, max: 255 }, // Length
201 VIDEO_QUOTA: { min: -1 }
204 REASON: { min: 2, max: 300 } // Length
207 NAME: { min: 3, max: 120 }, // Length
208 DESCRIPTION: { min: 3, max: 500 }, // Length
209 SUPPORT: { min: 3, max: 500 }, // Length
210 URL: { min: 3, max: 2000 } // Length
213 NAME: { min: 3, max: 120 }, // Length
214 LANGUAGE: { min: 1, max: 10 }, // Length
215 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
216 DESCRIPTION: { min: 3, max: 10000 }, // Length
217 SUPPORT: { min: 3, max: 500 }, // Length
219 EXTNAME: [ '.jpg', '.jpeg' ],
221 max: 2 * 1024 * 1024 // 2MB
224 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
225 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
226 DURATION: { min: 1 }, // Number
227 TAGS: { min: 0, max: 5 }, // Number of total tags
228 TAG: { min: 2, max: 30 }, // Length
229 THUMBNAIL: { min: 2, max: 30 },
230 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
233 DISLIKES: { min: 0 },
234 FILE_SIZE: { min: 10 },
235 URL: { min: 3, max: 2000 } // Length
238 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
239 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
240 URL: { min: 3, max: 2000 }, // Length
242 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
244 max: 2 * 1024 * 1024 // 2MB
252 TEXT: { min: 1, max: 3000 }, // Length
253 URL: { min: 3, max: 2000 } // Length
256 URL: { min: 3, max: 2000 } // Length
260 const RATES_LIMIT = {
262 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
263 MAX: 15 // 15 attempts
267 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
268 const VIDEO_TRANSCODING_FPS = {
273 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
278 const VIDEO_CATEGORIES = {
293 15: 'Science & Technology',
299 // See https://creativecommons.org/licenses/?lang=en
300 const VIDEO_LICENCES = {
302 2: 'Attribution - Share Alike',
303 3: 'Attribution - No Derivatives',
304 4: 'Attribution - Non Commercial',
305 5: 'Attribution - Non Commercial - Share Alike',
306 6: 'Attribution - Non Commercial - No Derivatives',
307 7: 'Public Domain Dedication'
310 const VIDEO_LANGUAGES = buildLanguages()
312 const VIDEO_PRIVACIES = {
313 [VideoPrivacy.PUBLIC]: 'Public',
314 [VideoPrivacy.UNLISTED]: 'Unlisted',
315 [VideoPrivacy.PRIVATE]: 'Private'
318 const VIDEO_MIMETYPE_EXT = {
319 'video/webm': '.webm',
324 const IMAGE_MIMETYPE_EXT = {
330 // ---------------------------------------------------------------------------
332 const SERVER_ACTOR_NAME = 'peertube'
334 const ACTIVITY_PUB = {
335 POTENTIAL_ACCEPT_HEADERS: [
336 'application/activity+json',
337 'application/ld+json',
338 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
340 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
341 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
342 COLLECTION_ITEMS_PER_PAGE: 10,
343 FETCH_PAGE_LIMIT: 100,
345 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
346 TORRENT: [ 'application/x-bittorrent' ],
347 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
349 MAX_RECURSION_COMMENTS: 100,
350 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
353 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
356 APPLICATION: 'Application'
359 // ---------------------------------------------------------------------------
361 const PRIVATE_RSA_KEY_SIZE = 2048
363 // Password encryption
364 const BCRYPT_SALT_SIZE = 10
366 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
368 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
369 DO_NOT_LIST: 'do_not_list',
374 // ---------------------------------------------------------------------------
376 // Express static paths (router)
377 const STATIC_PATHS = {
378 PREVIEWS: '/static/previews/',
379 THUMBNAILS: '/static/thumbnails/',
380 TORRENTS: '/static/torrents/',
381 WEBSEED: '/static/webseed/',
382 AVATARS: '/static/avatars/'
386 let STATIC_MAX_AGE = '30d'
388 // Videos thumbnail size
389 const THUMBNAILS_SIZE = {
393 const PREVIEWS_SIZE = {
397 const AVATARS_SIZE = {
407 // Sub folders of cache directory
410 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
414 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
416 // ---------------------------------------------------------------------------
418 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
420 // ---------------------------------------------------------------------------
426 // ---------------------------------------------------------------------------
428 // Special constants for a test instance
429 if (isTestInstance() === true) {
430 ACTOR_FOLLOW_SCORE.BASE = 20
431 REMOTE_SCHEME.HTTP = 'http'
432 REMOTE_SCHEME.WS = 'ws'
434 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
435 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
436 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
437 SCHEDULER_INTERVAL = 10000
438 VIDEO_VIEW_LIFETIME = 1000 // 1 second
441 updateWebserverConfig()
443 // ---------------------------------------------------------------------------
456 LAST_MIGRATION_VERSION,
458 OPENGRAPH_AND_OEMBED_COMMENT,
459 BROADCAST_CONCURRENCY,
460 PAGINATION_COUNT_DEFAULT,
466 PRIVATE_RSA_KEY_SIZE,
467 ROUTE_CACHE_LIFETIME,
474 ACTIVITY_PUB_ACTOR_TYPES,
482 VIDEO_TRANSCODING_FPS,
485 USER_PASSWORD_RESET_LIFETIME,
489 JOB_COMPLETED_LIFETIME,
493 // ---------------------------------------------------------------------------
495 function getLocalConfigFilePath () {
496 const configSources = config.util.getConfigSources()
497 if (configSources.length === 0) throw new Error('Invalid config source.')
499 let filename = 'local'
500 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
501 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
503 return join(dirname(configSources[ 0 ].name), filename + '.json')
506 function updateWebserverConfig () {
507 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
508 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
511 function buildLanguages () {
512 const iso639 = require('iso-639-3')
514 const languages: { [ id: string ]: string } = {}
516 const signLanguages = [
517 'sgn', // Sign languages (macro language)
529 'sfs', // South African
534 // Only add ISO639-1 languages and some sign languages (ISO639-3)
537 return (l.iso6391 !== null && l.type === 'living') ||
538 signLanguages.indexOf(l.iso6393) !== -1
540 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
545 export function reloadConfig () {
547 function directory () {
548 if (process.env.NODE_CONFIG_DIR) {
549 return process.env.NODE_CONFIG_DIR
552 return join(root(), 'config')
556 for (const fileName in require.cache) {
557 if (-1 === fileName.indexOf(directory())) {
561 delete require.cache[fileName]
564 delete require.cache[require.resolve('config')]
569 config = require('config')
571 updateWebserverConfig()