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'),
130 TRUST_PROXY: config.get<string[]>('trust_proxy'),
132 LEVEL: config.get<string>('log.level')
135 get EMAIL () { return config.get<string>('admin.email') }
138 get ENABLED () { return config.get<boolean>('signup.enabled') },
139 get LIMIT () { return config.get<number>('signup.limit') }
142 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
145 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
146 get THREADS () { return config.get<number>('transcoding.threads') },
148 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
149 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
150 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
151 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
152 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
157 get SIZE () { return config.get<number>('cache.previews.size') }
161 get NAME () { return config.get<string>('instance.name') },
162 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
163 get DESCRIPTION () { return config.get<string>('instance.description') },
164 get TERMS () { return config.get<string>('instance.terms') },
165 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
167 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
168 get CSS () { return config.get<string>('instance.customizations.css') }
173 // ---------------------------------------------------------------------------
175 const CONSTRAINTS_FIELDS = {
177 USERNAME: { min: 3, max: 20 }, // Length
178 PASSWORD: { min: 6, max: 255 }, // Length
179 DESCRIPTION: { min: 3, max: 250 }, // Length
180 VIDEO_QUOTA: { min: -1 }
183 REASON: { min: 2, max: 300 } // Length
186 NAME: { min: 3, max: 120 }, // Length
187 DESCRIPTION: { min: 3, max: 250 }, // Length
188 SUPPORT: { min: 3, max: 300 }, // Length
189 URL: { min: 3, max: 2000 } // Length
192 NAME: { min: 3, max: 120 }, // Length
193 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
194 DESCRIPTION: { min: 3, max: 10000 }, // Length
195 SUPPORT: { min: 3, max: 300 }, // Length
197 EXTNAME: [ '.jpg', '.jpeg' ],
199 max: 2 * 1024 * 1024 // 2MB
202 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
203 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
204 DURATION: { min: 1 }, // Number
205 TAGS: { min: 0, max: 5 }, // Number of total tags
206 TAG: { min: 2, max: 30 }, // Length
207 THUMBNAIL: { min: 2, max: 30 },
208 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
211 DISLIKES: { min: 0 },
212 FILE_SIZE: { min: 10 },
213 URL: { min: 3, max: 2000 } // Length
216 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
217 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
218 URL: { min: 3, max: 2000 }, // Length
220 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
222 max: 2 * 1024 * 1024 // 2MB
230 TEXT: { min: 1, max: 3000 }, // Length
231 URL: { min: 3, max: 2000 } // Length
234 URL: { min: 3, max: 2000 } // Length
238 const RATES_LIMIT = {
240 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
241 MAX: 15 // 15 attempts
245 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
246 const VIDEO_TRANSCODING_FPS = {
251 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
256 const VIDEO_CATEGORIES = {
271 15: 'Science & Technology',
277 // See https://creativecommons.org/licenses/?lang=en
278 const VIDEO_LICENCES = {
280 2: 'Attribution - Share Alike',
281 3: 'Attribution - No Derivatives',
282 4: 'Attribution - Non Commercial',
283 5: 'Attribution - Non Commercial - Share Alike',
284 6: 'Attribution - Non Commercial - No Derivatives',
285 7: 'Public Domain Dedication'
288 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
289 const VIDEO_LANGUAGES = {
304 1000: 'Sign Language',
305 1001: 'American Sign Language',
306 1002: 'Arab Sign Language',
307 1003: 'British Sign Language',
308 1004: 'Brazilian Sign Language',
309 1005: 'Chinese Sign Language',
310 1006: 'Czech Sign Language',
311 1007: 'Danish Sign Language',
312 1008: 'French Sign Language',
313 1009: 'German Sign Language',
314 1010: 'Indo-Pakistani Sign Language',
315 1011: 'Japanese Sign Language',
316 1012: 'South African Sign Language',
317 1013: 'Swedish Sign Language',
318 1014: 'Russian Sign Language'
321 const VIDEO_PRIVACIES = {
322 [VideoPrivacy.PUBLIC]: 'Public',
323 [VideoPrivacy.UNLISTED]: 'Unlisted',
324 [VideoPrivacy.PRIVATE]: 'Private'
327 const VIDEO_MIMETYPE_EXT = {
328 'video/webm': '.webm',
333 const IMAGE_MIMETYPE_EXT = {
339 // ---------------------------------------------------------------------------
341 const SERVER_ACTOR_NAME = 'peertube'
343 const ACTIVITY_PUB = {
344 POTENTIAL_ACCEPT_HEADERS: [
345 'application/activity+json',
346 'application/ld+json',
347 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
349 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
350 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
351 COLLECTION_ITEMS_PER_PAGE: 10,
352 FETCH_PAGE_LIMIT: 100,
354 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
355 TORRENT: [ 'application/x-bittorrent' ],
356 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
358 MAX_RECURSION_COMMENTS: 100,
359 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
362 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
365 APPLICATION: 'Application'
368 // ---------------------------------------------------------------------------
370 const PRIVATE_RSA_KEY_SIZE = 2048
372 // Password encryption
373 const BCRYPT_SALT_SIZE = 10
375 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
377 // ---------------------------------------------------------------------------
379 // Express static paths (router)
380 const STATIC_PATHS = {
381 PREVIEWS: '/static/previews/',
382 THUMBNAILS: '/static/thumbnails/',
383 TORRENTS: '/static/torrents/',
384 WEBSEED: '/static/webseed/',
385 AVATARS: '/static/avatars/'
389 let STATIC_MAX_AGE = '30d'
391 // Videos thumbnail size
392 const THUMBNAILS_SIZE = {
396 const PREVIEWS_SIZE = {
400 const AVATARS_SIZE = {
410 // Sub folders of cache directory
413 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
417 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
419 // ---------------------------------------------------------------------------
421 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
423 // ---------------------------------------------------------------------------
425 // Special constants for a test instance
426 if (isTestInstance() === true) {
427 ACTOR_FOLLOW_SCORE.BASE = 20
428 REMOTE_SCHEME.HTTP = 'http'
429 REMOTE_SCHEME.WS = 'ws'
431 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
432 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
433 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
434 SCHEDULER_INTERVAL = 10000
435 VIDEO_VIEW_LIFETIME = 1000 // 1 second
438 updateWebserverConfig()
440 // ---------------------------------------------------------------------------
453 LAST_MIGRATION_VERSION,
455 OPENGRAPH_AND_OEMBED_COMMENT,
456 PAGINATION_COUNT_DEFAULT,
462 PRIVATE_RSA_KEY_SIZE,
467 ACTIVITY_PUB_ACTOR_TYPES,
475 VIDEO_TRANSCODING_FPS,
476 USER_PASSWORD_RESET_LIFETIME,
480 JOB_COMPLETED_LIFETIME,
484 // ---------------------------------------------------------------------------
486 function getLocalConfigFilePath () {
487 const configSources = config.util.getConfigSources()
488 if (configSources.length === 0) throw new Error('Invalid config source.')
490 let filename = 'local'
491 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
492 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
494 return join(dirname(configSources[ 0 ].name), filename + '.json')
497 function updateWebserverConfig () {
498 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
499 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
502 export function reloadConfig () {
504 function directory () {
505 if (process.env.NODE_CONFIG_DIR) {
506 return process.env.NODE_CONFIG_DIR
509 return join(root(), 'config')
513 for (const fileName in require.cache) {
514 if (-1 === fileName.indexOf(directory())) {
518 delete require.cache[fileName]
521 delete require.cache[require.resolve('config')]
526 config = require('config')
528 updateWebserverConfig()