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 = 200
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,
68 'activitypub-follow': 5,
72 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
73 'activitypub-http-broadcast': 1,
74 'activitypub-http-unicast': 5,
75 'activitypub-http-fetcher': 1,
76 'activitypub-follow': 3,
81 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
84 let SCHEDULER_INTERVAL = 60000 * 60
86 // ---------------------------------------------------------------------------
89 CUSTOM_FILE: getLocalConfigFilePath(),
91 PORT: config.get<number>('listen.port'),
92 HOSTNAME: config.get<string>('listen.hostname')
95 DBNAME: 'peertube' + config.get<string>('database.suffix'),
96 HOSTNAME: config.get<string>('database.hostname'),
97 PORT: config.get<number>('database.port'),
98 USERNAME: config.get<string>('database.username'),
99 PASSWORD: config.get<string>('database.password')
102 HOSTNAME: config.get<string>('redis.hostname'),
103 PORT: config.get<number>('redis.port'),
104 AUTH: config.get<string>('redis.auth')
107 HOSTNAME: config.get<string>('smtp.hostname'),
108 PORT: config.get<number>('smtp.port'),
109 USERNAME: config.get<string>('smtp.username'),
110 PASSWORD: config.get<string>('smtp.password'),
111 TLS: config.get<boolean>('smtp.tls'),
112 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
113 CA_FILE: config.get<string>('smtp.ca_file'),
114 FROM_ADDRESS: config.get<string>('smtp.from_address')
117 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
118 LOG_DIR: buildPath(config.get<string>('storage.logs')),
119 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
120 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
121 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
122 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
123 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
126 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
127 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
128 HOSTNAME: config.get<string>('webserver.hostname'),
129 PORT: config.get<number>('webserver.port'),
133 TRUST_PROXY: config.get<string[]>('trust_proxy'),
135 LEVEL: config.get<string>('log.level')
138 get EMAIL () { return config.get<string>('admin.email') }
141 get ENABLED () { return config.get<boolean>('signup.enabled') },
142 get LIMIT () { return config.get<number>('signup.limit') }
145 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
148 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
149 get THREADS () { return config.get<number>('transcoding.threads') },
151 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
152 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
153 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
154 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
155 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
160 get SIZE () { return config.get<number>('cache.previews.size') }
164 get NAME () { return config.get<string>('instance.name') },
165 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
166 get DESCRIPTION () { return config.get<string>('instance.description') },
167 get TERMS () { return config.get<string>('instance.terms') },
168 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
170 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
171 get CSS () { return config.get<string>('instance.customizations.css') }
176 // ---------------------------------------------------------------------------
178 const CONSTRAINTS_FIELDS = {
180 USERNAME: { min: 3, max: 20 }, // Length
181 PASSWORD: { min: 6, max: 255 }, // Length
182 DESCRIPTION: { min: 3, max: 250 }, // Length
183 VIDEO_QUOTA: { min: -1 }
186 REASON: { min: 2, max: 300 } // Length
189 NAME: { min: 3, max: 120 }, // Length
190 DESCRIPTION: { min: 3, max: 250 }, // Length
191 SUPPORT: { min: 3, max: 300 }, // Length
192 URL: { min: 3, max: 2000 } // Length
195 NAME: { min: 3, max: 120 }, // Length
196 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
197 DESCRIPTION: { min: 3, max: 10000 }, // Length
198 SUPPORT: { min: 3, max: 300 }, // Length
200 EXTNAME: [ '.jpg', '.jpeg' ],
202 max: 2 * 1024 * 1024 // 2MB
205 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
206 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
207 DURATION: { min: 1 }, // Number
208 TAGS: { min: 0, max: 5 }, // Number of total tags
209 TAG: { min: 2, max: 30 }, // Length
210 THUMBNAIL: { min: 2, max: 30 },
211 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
214 DISLIKES: { min: 0 },
215 FILE_SIZE: { min: 10 },
216 URL: { min: 3, max: 2000 } // Length
219 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
220 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
221 URL: { min: 3, max: 2000 }, // Length
223 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
225 max: 2 * 1024 * 1024 // 2MB
233 TEXT: { min: 1, max: 3000 }, // Length
234 URL: { min: 3, max: 2000 } // Length
237 URL: { min: 3, max: 2000 } // Length
241 const RATES_LIMIT = {
243 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
244 MAX: 15 // 15 attempts
248 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
249 const VIDEO_TRANSCODING_FPS = {
254 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
259 const VIDEO_CATEGORIES = {
274 15: 'Science & Technology',
280 // See https://creativecommons.org/licenses/?lang=en
281 const VIDEO_LICENCES = {
283 2: 'Attribution - Share Alike',
284 3: 'Attribution - No Derivatives',
285 4: 'Attribution - Non Commercial',
286 5: 'Attribution - Non Commercial - Share Alike',
287 6: 'Attribution - Non Commercial - No Derivatives',
288 7: 'Public Domain Dedication'
291 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
292 const VIDEO_LANGUAGES = {
307 1000: 'Sign Language',
308 1001: 'American Sign Language',
309 1002: 'Arab Sign Language',
310 1003: 'British Sign Language',
311 1004: 'Brazilian Sign Language',
312 1005: 'Chinese Sign Language',
313 1006: 'Czech Sign Language',
314 1007: 'Danish Sign Language',
315 1008: 'French Sign Language',
316 1009: 'German Sign Language',
317 1010: 'Indo-Pakistani Sign Language',
318 1011: 'Japanese Sign Language',
319 1012: 'South African Sign Language',
320 1013: 'Swedish Sign Language',
321 1014: 'Russian Sign Language'
324 const VIDEO_PRIVACIES = {
325 [VideoPrivacy.PUBLIC]: 'Public',
326 [VideoPrivacy.UNLISTED]: 'Unlisted',
327 [VideoPrivacy.PRIVATE]: 'Private'
330 const VIDEO_MIMETYPE_EXT = {
331 'video/webm': '.webm',
336 const IMAGE_MIMETYPE_EXT = {
342 // ---------------------------------------------------------------------------
344 const SERVER_ACTOR_NAME = 'peertube'
346 const ACTIVITY_PUB = {
347 POTENTIAL_ACCEPT_HEADERS: [
348 'application/activity+json',
349 'application/ld+json',
350 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
352 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
353 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
354 COLLECTION_ITEMS_PER_PAGE: 10,
355 FETCH_PAGE_LIMIT: 100,
357 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
358 TORRENT: [ 'application/x-bittorrent' ],
359 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
361 MAX_RECURSION_COMMENTS: 100,
362 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
365 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
368 APPLICATION: 'Application'
371 // ---------------------------------------------------------------------------
373 const PRIVATE_RSA_KEY_SIZE = 2048
375 // Password encryption
376 const BCRYPT_SALT_SIZE = 10
378 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
380 // ---------------------------------------------------------------------------
382 // Express static paths (router)
383 const STATIC_PATHS = {
384 PREVIEWS: '/static/previews/',
385 THUMBNAILS: '/static/thumbnails/',
386 TORRENTS: '/static/torrents/',
387 WEBSEED: '/static/webseed/',
388 AVATARS: '/static/avatars/'
392 let STATIC_MAX_AGE = '30d'
394 // Videos thumbnail size
395 const THUMBNAILS_SIZE = {
399 const PREVIEWS_SIZE = {
403 const AVATARS_SIZE = {
413 // Sub folders of cache directory
416 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
420 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
422 // ---------------------------------------------------------------------------
424 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
426 // ---------------------------------------------------------------------------
430 CACHE_LIFETIME: 1000 * 60 * 15 // 15 minutes
433 // ---------------------------------------------------------------------------
435 // Special constants for a test instance
436 if (isTestInstance() === true) {
437 ACTOR_FOLLOW_SCORE.BASE = 20
438 REMOTE_SCHEME.HTTP = 'http'
439 REMOTE_SCHEME.WS = 'ws'
441 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
442 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
443 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
444 SCHEDULER_INTERVAL = 10000
445 VIDEO_VIEW_LIFETIME = 1000 // 1 second
448 updateWebserverConfig()
450 // ---------------------------------------------------------------------------
463 LAST_MIGRATION_VERSION,
465 OPENGRAPH_AND_OEMBED_COMMENT,
466 PAGINATION_COUNT_DEFAULT,
472 PRIVATE_RSA_KEY_SIZE,
478 ACTIVITY_PUB_ACTOR_TYPES,
486 VIDEO_TRANSCODING_FPS,
487 USER_PASSWORD_RESET_LIFETIME,
491 JOB_COMPLETED_LIFETIME,
495 // ---------------------------------------------------------------------------
497 function getLocalConfigFilePath () {
498 const configSources = config.util.getConfigSources()
499 if (configSources.length === 0) throw new Error('Invalid config source.')
501 let filename = 'local'
502 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
503 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
505 return join(dirname(configSources[ 0 ].name), filename + '.json')
508 function updateWebserverConfig () {
509 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
510 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
513 export function reloadConfig () {
515 function directory () {
516 if (process.env.NODE_CONFIG_DIR) {
517 return process.env.NODE_CONFIG_DIR
520 return join(root(), 'config')
524 for (const fileName in require.cache) {
525 if (-1 === fileName.indexOf(directory())) {
529 delete require.cache[fileName]
532 delete require.cache[require.resolve('config')]
537 config = require('config')
539 updateWebserverConfig()