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', '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 = 10 // How many requests in parallel we do in activitypub-http-broadcast job
82 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
83 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
84 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
87 let SCHEDULER_INTERVAL = 60000 * 60
89 // ---------------------------------------------------------------------------
92 CUSTOM_FILE: getLocalConfigFilePath(),
94 PORT: config.get<number>('listen.port'),
95 HOSTNAME: config.get<string>('listen.hostname')
98 DBNAME: 'peertube' + config.get<string>('database.suffix'),
99 HOSTNAME: config.get<string>('database.hostname'),
100 PORT: config.get<number>('database.port'),
101 USERNAME: config.get<string>('database.username'),
102 PASSWORD: config.get<string>('database.password')
105 HOSTNAME: config.get<string>('redis.hostname'),
106 PORT: config.get<number>('redis.port'),
107 AUTH: config.get<string>('redis.auth')
110 HOSTNAME: config.get<string>('smtp.hostname'),
111 PORT: config.get<number>('smtp.port'),
112 USERNAME: config.get<string>('smtp.username'),
113 PASSWORD: config.get<string>('smtp.password'),
114 TLS: config.get<boolean>('smtp.tls'),
115 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
116 CA_FILE: config.get<string>('smtp.ca_file'),
117 FROM_ADDRESS: config.get<string>('smtp.from_address')
120 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
121 LOG_DIR: buildPath(config.get<string>('storage.logs')),
122 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
123 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
124 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
125 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
126 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
129 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
130 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
131 HOSTNAME: config.get<string>('webserver.hostname'),
132 PORT: config.get<number>('webserver.port'),
136 TRUST_PROXY: config.get<string[]>('trust_proxy'),
138 LEVEL: config.get<string>('log.level')
141 get EMAIL () { return config.get<string>('admin.email') }
144 get ENABLED () { return config.get<boolean>('signup.enabled') },
145 get LIMIT () { return config.get<number>('signup.limit') }
148 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
151 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
152 get THREADS () { return config.get<number>('transcoding.threads') },
154 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
155 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
156 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
157 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
158 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
163 get SIZE () { return config.get<number>('cache.previews.size') }
167 get NAME () { return config.get<string>('instance.name') },
168 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
169 get DESCRIPTION () { return config.get<string>('instance.description') },
170 get TERMS () { return config.get<string>('instance.terms') },
171 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
172 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
174 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
175 get CSS () { return config.get<string>('instance.customizations.css') }
180 // ---------------------------------------------------------------------------
182 const CONSTRAINTS_FIELDS = {
184 NAME: { min: 3, max: 120 }, // Length
185 DESCRIPTION: { min: 3, max: 250 }, // Length
186 USERNAME: { min: 3, max: 20 }, // Length
187 PASSWORD: { min: 6, max: 255 }, // Length
188 VIDEO_QUOTA: { min: -1 }
191 REASON: { min: 2, max: 300 } // Length
194 NAME: { min: 3, max: 120 }, // Length
195 DESCRIPTION: { min: 3, max: 500 }, // Length
196 SUPPORT: { min: 3, max: 500 }, // Length
197 URL: { min: 3, max: 2000 } // Length
200 NAME: { min: 3, max: 120 }, // Length
201 LANGUAGE: { min: 1, max: 10 }, // Length
202 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
203 DESCRIPTION: { min: 3, max: 10000 }, // Length
204 SUPPORT: { min: 3, max: 500 }, // Length
206 EXTNAME: [ '.jpg', '.jpeg' ],
208 max: 2 * 1024 * 1024 // 2MB
211 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
212 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
213 DURATION: { min: 1 }, // Number
214 TAGS: { min: 0, max: 5 }, // Number of total tags
215 TAG: { min: 2, max: 30 }, // Length
216 THUMBNAIL: { min: 2, max: 30 },
217 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
220 DISLIKES: { min: 0 },
221 FILE_SIZE: { min: 10 },
222 URL: { min: 3, max: 2000 } // Length
225 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
226 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
227 URL: { min: 3, max: 2000 }, // Length
229 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
231 max: 2 * 1024 * 1024 // 2MB
239 TEXT: { min: 1, max: 3000 }, // Length
240 URL: { min: 3, max: 2000 } // Length
243 URL: { min: 3, max: 2000 } // Length
247 const RATES_LIMIT = {
249 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
250 MAX: 15 // 15 attempts
254 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
255 const VIDEO_TRANSCODING_FPS = {
260 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
265 const VIDEO_CATEGORIES = {
280 15: 'Science & Technology',
286 // See https://creativecommons.org/licenses/?lang=en
287 const VIDEO_LICENCES = {
289 2: 'Attribution - Share Alike',
290 3: 'Attribution - No Derivatives',
291 4: 'Attribution - Non Commercial',
292 5: 'Attribution - Non Commercial - Share Alike',
293 6: 'Attribution - Non Commercial - No Derivatives',
294 7: 'Public Domain Dedication'
297 const VIDEO_LANGUAGES = buildLanguages()
299 const VIDEO_PRIVACIES = {
300 [VideoPrivacy.PUBLIC]: 'Public',
301 [VideoPrivacy.UNLISTED]: 'Unlisted',
302 [VideoPrivacy.PRIVATE]: 'Private'
305 const VIDEO_MIMETYPE_EXT = {
306 'video/webm': '.webm',
311 const IMAGE_MIMETYPE_EXT = {
317 // ---------------------------------------------------------------------------
319 const SERVER_ACTOR_NAME = 'peertube'
321 const ACTIVITY_PUB = {
322 POTENTIAL_ACCEPT_HEADERS: [
323 'application/activity+json',
324 'application/ld+json',
325 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
327 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
328 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
329 COLLECTION_ITEMS_PER_PAGE: 10,
330 FETCH_PAGE_LIMIT: 100,
332 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
333 TORRENT: [ 'application/x-bittorrent' ],
334 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
336 MAX_RECURSION_COMMENTS: 100,
337 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
340 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
343 APPLICATION: 'Application'
346 // ---------------------------------------------------------------------------
348 const PRIVATE_RSA_KEY_SIZE = 2048
350 // Password encryption
351 const BCRYPT_SALT_SIZE = 10
353 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
355 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
356 DO_NOT_LIST: 'do_not_list',
361 // ---------------------------------------------------------------------------
363 // Express static paths (router)
364 const STATIC_PATHS = {
365 PREVIEWS: '/static/previews/',
366 THUMBNAILS: '/static/thumbnails/',
367 TORRENTS: '/static/torrents/',
368 WEBSEED: '/static/webseed/',
369 AVATARS: '/static/avatars/'
373 let STATIC_MAX_AGE = '30d'
375 // Videos thumbnail size
376 const THUMBNAILS_SIZE = {
380 const PREVIEWS_SIZE = {
384 const AVATARS_SIZE = {
394 // Sub folders of cache directory
397 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
401 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
403 // ---------------------------------------------------------------------------
405 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
407 // ---------------------------------------------------------------------------
411 CACHE_LIFETIME: 1000 * 60 * 15 // 15 minutes
414 // ---------------------------------------------------------------------------
416 // Special constants for a test instance
417 if (isTestInstance() === true) {
418 ACTOR_FOLLOW_SCORE.BASE = 20
419 REMOTE_SCHEME.HTTP = 'http'
420 REMOTE_SCHEME.WS = 'ws'
422 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
423 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
424 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
425 SCHEDULER_INTERVAL = 10000
426 VIDEO_VIEW_LIFETIME = 1000 // 1 second
429 updateWebserverConfig()
431 // ---------------------------------------------------------------------------
444 LAST_MIGRATION_VERSION,
446 OPENGRAPH_AND_OEMBED_COMMENT,
447 BROADCAST_CONCURRENCY,
448 PAGINATION_COUNT_DEFAULT,
454 PRIVATE_RSA_KEY_SIZE,
461 ACTIVITY_PUB_ACTOR_TYPES,
469 VIDEO_TRANSCODING_FPS,
472 USER_PASSWORD_RESET_LIFETIME,
476 JOB_COMPLETED_LIFETIME,
480 // ---------------------------------------------------------------------------
482 function getLocalConfigFilePath () {
483 const configSources = config.util.getConfigSources()
484 if (configSources.length === 0) throw new Error('Invalid config source.')
486 let filename = 'local'
487 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
488 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
490 return join(dirname(configSources[ 0 ].name), filename + '.json')
493 function updateWebserverConfig () {
494 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
495 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
498 function buildLanguages () {
499 const iso639 = require('iso-639-3')
501 const languages: { [ id: string ]: string } = {}
503 const signLanguages = [
504 'sgn', // Sign languages (macro language)
516 'sfs', // South African
521 // Only add ISO639-1 languages and some sign languages (ISO639-3)
524 return (l.iso6391 !== null && l.type === 'living') ||
525 signLanguages.indexOf(l.iso6393) !== -1
527 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
532 export function reloadConfig () {
534 function directory () {
535 if (process.env.NODE_CONFIG_DIR) {
536 return process.env.NODE_CONFIG_DIR
539 return join(root(), 'config')
543 for (const fileName in require.cache) {
544 if (-1 === fileName.indexOf(directory())) {
548 delete require.cache[fileName]
551 delete require.cache[require.resolve('config')]
556 config = require('config')
558 updateWebserverConfig()