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'
10 // Use a variable to reload the configuration if we need
11 let config: IConfig = require('config')
13 // ---------------------------------------------------------------------------
15 const LAST_MIGRATION_VERSION = 195
17 // ---------------------------------------------------------------------------
20 const API_VERSION = 'v1'
22 // Number of results by default for the pagination
23 const PAGINATION_COUNT_DEFAULT = 15
25 // Sortable columns per schema
26 const SORTABLE_COLUMNS = {
27 USERS: [ 'id', 'username', 'createdAt' ],
28 ACCOUNTS: [ 'createdAt' ],
29 JOBS: [ 'createdAt' ],
30 VIDEO_ABUSES: [ 'id', 'createdAt' ],
31 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
32 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
33 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
34 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
35 FOLLOWERS: [ 'createdAt' ],
36 FOLLOWING: [ 'createdAt' ]
39 const OAUTH_LIFETIME = {
40 ACCESS_TOKEN: 3600 * 4, // 4 hours
41 REFRESH_TOKEN: 1209600 // 2 weeks
44 // ---------------------------------------------------------------------------
46 // Number of points we add/remove after a successful/bad request
47 const ACTOR_FOLLOW_SCORE = {
54 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
59 const REMOTE_SCHEME = {
64 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
65 'activitypub-http-broadcast': 5,
66 'activitypub-http-unicast': 5,
67 'activitypub-http-fetcher': 5,
71 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
72 'activitypub-http-broadcast': 1,
73 'activitypub-http-unicast': 5,
74 'activitypub-http-fetcher': 1,
79 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
82 let SCHEDULER_INTERVAL = 60000 * 60
84 // ---------------------------------------------------------------------------
87 CUSTOM_FILE: getLocalConfigFilePath(),
89 PORT: config.get<number>('listen.port')
92 DBNAME: 'peertube' + config.get<string>('database.suffix'),
93 HOSTNAME: config.get<string>('database.hostname'),
94 PORT: config.get<number>('database.port'),
95 USERNAME: config.get<string>('database.username'),
96 PASSWORD: config.get<string>('database.password')
99 HOSTNAME: config.get<string>('redis.hostname'),
100 PORT: config.get<number>('redis.port'),
101 AUTH: config.get<string>('redis.auth')
104 HOSTNAME: config.get<string>('smtp.hostname'),
105 PORT: config.get<number>('smtp.port'),
106 USERNAME: config.get<string>('smtp.username'),
107 PASSWORD: config.get<string>('smtp.password'),
108 TLS: config.get<boolean>('smtp.tls'),
109 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
110 CA_FILE: config.get<string>('smtp.ca_file'),
111 FROM_ADDRESS: config.get<string>('smtp.from_address')
114 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
115 LOG_DIR: buildPath(config.get<string>('storage.logs')),
116 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
117 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
118 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
119 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
120 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
123 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
124 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
125 HOSTNAME: config.get<string>('webserver.hostname'),
126 PORT: config.get<number>('webserver.port'),
131 LEVEL: config.get<string>('log.level')
134 get EMAIL () { return config.get<string>('admin.email') }
137 get ENABLED () { return config.get<boolean>('signup.enabled') },
138 get LIMIT () { return config.get<number>('signup.limit') }
141 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
144 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
145 get THREADS () { return config.get<number>('transcoding.threads') },
147 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
148 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
149 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
150 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
151 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
156 get SIZE () { return config.get<number>('cache.previews.size') }
160 get NAME () { return config.get<string>('instance.name') },
161 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
162 get DESCRIPTION () { return config.get<string>('instance.description') },
163 get TERMS () { return config.get<string>('instance.terms') },
164 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
166 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
167 get CSS () { return config.get<string>('instance.customizations.css') }
172 // ---------------------------------------------------------------------------
174 const CONSTRAINTS_FIELDS = {
176 USERNAME: { min: 3, max: 20 }, // Length
177 PASSWORD: { min: 6, max: 255 }, // Length
178 DESCRIPTION: { min: 3, max: 250 }, // Length
179 VIDEO_QUOTA: { min: -1 }
182 REASON: { min: 2, max: 300 } // Length
185 NAME: { min: 3, max: 120 }, // Length
186 DESCRIPTION: { min: 3, max: 250 }, // Length
187 SUPPORT: { min: 3, max: 300 }, // Length
188 URL: { min: 3, max: 2000 } // Length
191 NAME: { min: 3, max: 120 }, // Length
192 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
193 DESCRIPTION: { min: 3, max: 10000 }, // Length
194 SUPPORT: { min: 3, max: 300 }, // Length
196 EXTNAME: [ '.jpg', '.jpeg' ],
198 max: 2 * 1024 * 1024 // 2MB
201 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
202 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
203 DURATION: { min: 1 }, // Number
204 TAGS: { min: 0, max: 5 }, // Number of total tags
205 TAG: { min: 2, max: 30 }, // Length
206 THUMBNAIL: { min: 2, max: 30 },
207 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
210 DISLIKES: { min: 0 },
211 FILE_SIZE: { min: 10 },
212 URL: { min: 3, max: 2000 } // Length
215 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
216 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
217 URL: { min: 3, max: 2000 }, // Length
219 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
221 max: 2 * 1024 * 1024 // 2MB
229 TEXT: { min: 1, max: 3000 }, // Length
230 URL: { min: 3, max: 2000 } // Length
233 URL: { min: 3, max: 2000 } // Length
237 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
238 const VIDEO_TRANSCODING_FPS = {
243 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
248 const VIDEO_CATEGORIES = {
263 15: 'Science & Technology',
269 // See https://creativecommons.org/licenses/?lang=en
270 const VIDEO_LICENCES = {
272 2: 'Attribution - Share Alike',
273 3: 'Attribution - No Derivatives',
274 4: 'Attribution - Non Commercial',
275 5: 'Attribution - Non Commercial - Share Alike',
276 6: 'Attribution - Non Commercial - No Derivatives',
277 7: 'Public Domain Dedication'
280 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
281 const VIDEO_LANGUAGES = {
296 1000: 'Sign Language',
297 1001: 'American Sign Language',
298 1002: 'Arab Sign Language',
299 1003: 'British Sign Language',
300 1004: 'Brazilian Sign Language',
301 1005: 'Chinese Sign Language',
302 1006: 'Czech Sign Language',
303 1007: 'Danish Sign Language',
304 1008: 'French Sign Language',
305 1009: 'German Sign Language',
306 1010: 'Indo-Pakistani Sign Language',
307 1011: 'Japanese Sign Language',
308 1012: 'South African Sign Language',
309 1013: 'Swedish Sign Language',
310 1014: 'Russian Sign Language'
313 const VIDEO_PRIVACIES = {
314 [VideoPrivacy.PUBLIC]: 'Public',
315 [VideoPrivacy.UNLISTED]: 'Unlisted',
316 [VideoPrivacy.PRIVATE]: 'Private'
319 const VIDEO_MIMETYPE_EXT = {
320 'video/webm': '.webm',
325 const IMAGE_MIMETYPE_EXT = {
331 // ---------------------------------------------------------------------------
333 const SERVER_ACTOR_NAME = 'peertube'
335 const ACTIVITY_PUB = {
336 POTENTIAL_ACCEPT_HEADERS: [
337 'application/activity+json',
338 'application/ld+json',
339 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
341 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
342 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
343 COLLECTION_ITEMS_PER_PAGE: 10,
344 FETCH_PAGE_LIMIT: 100,
346 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
347 TORRENT: [ 'application/x-bittorrent' ],
348 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
350 MAX_RECURSION_COMMENTS: 100,
351 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
354 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
357 APPLICATION: 'Application'
360 // ---------------------------------------------------------------------------
362 const PRIVATE_RSA_KEY_SIZE = 2048
364 // Password encryption
365 const BCRYPT_SALT_SIZE = 10
367 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
369 // ---------------------------------------------------------------------------
371 // Express static paths (router)
372 const STATIC_PATHS = {
373 PREVIEWS: '/static/previews/',
374 THUMBNAILS: '/static/thumbnails/',
375 TORRENTS: '/static/torrents/',
376 WEBSEED: '/static/webseed/',
377 AVATARS: '/static/avatars/'
381 let STATIC_MAX_AGE = '30d'
383 // Videos thumbnail size
384 const THUMBNAILS_SIZE = {
388 const PREVIEWS_SIZE = {
392 const AVATARS_SIZE = {
402 // Sub folders of cache directory
405 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
409 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
411 // ---------------------------------------------------------------------------
413 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
415 // ---------------------------------------------------------------------------
417 // Special constants for a test instance
418 if (isTestInstance() === true) {
419 ACTOR_FOLLOW_SCORE.BASE = 20
420 REMOTE_SCHEME.HTTP = 'http'
421 REMOTE_SCHEME.WS = 'ws'
423 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
424 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
425 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
426 SCHEDULER_INTERVAL = 10000
427 VIDEO_VIEW_LIFETIME = 1000 // 1 second
430 updateWebserverConfig()
432 // ---------------------------------------------------------------------------
445 LAST_MIGRATION_VERSION,
447 OPENGRAPH_AND_OEMBED_COMMENT,
448 PAGINATION_COUNT_DEFAULT,
454 PRIVATE_RSA_KEY_SIZE,
459 ACTIVITY_PUB_ACTOR_TYPES,
467 VIDEO_TRANSCODING_FPS,
468 USER_PASSWORD_RESET_LIFETIME,
471 JOB_COMPLETED_LIFETIME,
475 // ---------------------------------------------------------------------------
477 function getLocalConfigFilePath () {
478 const configSources = config.util.getConfigSources()
479 if (configSources.length === 0) throw new Error('Invalid config source.')
481 let filename = 'local'
482 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
483 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
485 return join(dirname(configSources[ 0 ].name), filename + '.json')
488 function updateWebserverConfig () {
489 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
490 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
493 export function reloadConfig () {
495 function directory () {
496 if (process.env.NODE_CONFIG_DIR) {
497 return process.env.NODE_CONFIG_DIR
500 return join(root(), 'config')
504 for (const fileName in require.cache) {
505 if (-1 === fileName.indexOf(directory())) {
509 delete require.cache[fileName]
512 delete require.cache[require.resolve('config')]
517 config = require('config')
519 updateWebserverConfig()