server/initializers/config.ts

   1 import bytes from 'bytes'
   2 import { IConfig } from 'config'
   3 import decache from 'decache'
   4 import { dirname, join } from 'path'
   5 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
   6 import { BroadcastMessageLevel } from '@shared/models/server'
   7 import { VideosRedundancyStrategy } from '../../shared/models'
   8 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
   9 // Do not use barrels, remain constants as independent as possible
  10 import { buildPath, parseBytes, parseDurationToMs, root } from '../helpers/core-utils'
  11
  12 // Use a variable to reload the configuration if we need
  13 let config: IConfig = require('config')
  14
  15 const configChangedHandlers: Function[] = []
  16
  17 const CONFIG = {
  18   CUSTOM_FILE: getLocalConfigFilePath(),
  19   LISTEN: {
  20     PORT: config.get<number>('listen.port'),
  21     HOSTNAME: config.get<string>('listen.hostname')
  22   },
  23   DATABASE: {
  24     DBNAME: config.has('database.name') ? config.get<string>('database.name') : 'peertube' + config.get<string>('database.suffix'),
  25     HOSTNAME: config.get<string>('database.hostname'),
  26     PORT: config.get<number>('database.port'),
  27     SSL: config.get<boolean>('database.ssl'),
  28     USERNAME: config.get<string>('database.username'),
  29     PASSWORD: config.get<string>('database.password'),
  30     POOL: {
  31       MAX: config.get<number>('database.pool.max')
  32     }
  33   },
  34   REDIS: {
  35     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
  36     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
  37     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
  38     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
  39     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
  40   },
  41   SMTP: {
  42     TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
  43     SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
  44     HOSTNAME: config.get<string>('smtp.hostname'),
  45     PORT: config.get<number>('smtp.port'),
  46     USERNAME: config.get<string>('smtp.username'),
  47     PASSWORD: config.get<string>('smtp.password'),
  48     TLS: config.get<boolean>('smtp.tls'),
  49     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
  50     CA_FILE: config.get<string>('smtp.ca_file'),
  51     FROM_ADDRESS: config.get<string>('smtp.from_address')
  52   },
  53   EMAIL: {
  54     BODY: {
  55       SIGNATURE: config.get<string>('email.body.signature')
  56     },
  57     SUBJECT: {
  58       PREFIX: config.get<string>('email.subject.prefix') + ' '
  59     }
  60   },
  61
  62   CLIENT: {
  63     VIDEOS: {
  64       MINIATURE: {
  65         get PREFER_AUTHOR_DISPLAY_NAME () { return config.get<boolean>('client.videos.miniature.prefer_author_display_name') }
  66       }
  67     }
  68   },
  69
  70   STORAGE: {
  71     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
  72     BIN_DIR: buildPath(config.get<string>('storage.bin')),
  73     ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
  74     LOG_DIR: buildPath(config.get<string>('storage.logs')),
  75     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
  76     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
  77     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
  78     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
  79     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
  80     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
  81     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
  82     CACHE_DIR: buildPath(config.get<string>('storage.cache')),
  83     PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
  84     CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
  85   },
  86   OBJECT_STORAGE: {
  87     ENABLED: config.get<boolean>('object_storage.enabled'),
  88     MAX_UPLOAD_PART: bytes.parse(config.get<string>('object_storage.max_upload_part')),
  89     ENDPOINT: config.get<string>('object_storage.endpoint'),
  90     REGION: config.get<string>('object_storage.region'),
  91     CREDENTIALS: {
  92       ACCESS_KEY_ID: config.get<string>('object_storage.credentials.access_key_id'),
  93       SECRET_ACCESS_KEY: config.get<string>('object_storage.credentials.secret_access_key')
  94     },
  95     VIDEOS: {
  96       BUCKET_NAME: config.get<string>('object_storage.videos.bucket_name'),
  97       PREFIX: config.get<string>('object_storage.videos.prefix'),
  98       BASE_URL: config.get<string>('object_storage.videos.base_url')
  99     },
 100     STREAMING_PLAYLISTS: {
 101       BUCKET_NAME: config.get<string>('object_storage.streaming_playlists.bucket_name'),
 102       PREFIX: config.get<string>('object_storage.streaming_playlists.prefix'),
 103       BASE_URL: config.get<string>('object_storage.streaming_playlists.base_url')
 104     }
 105   },
 106   WEBSERVER: {
 107     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 108     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 109     HOSTNAME: config.get<string>('webserver.hostname'),
 110     PORT: config.get<number>('webserver.port')
 111   },
 112   RATES_LIMIT: {
 113     API: {
 114       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
 115       MAX: config.get<number>('rates_limit.api.max')
 116     },
 117     SIGNUP: {
 118       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
 119       MAX: config.get<number>('rates_limit.signup.max')
 120     },
 121     LOGIN: {
 122       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
 123       MAX: config.get<number>('rates_limit.login.max')
 124     },
 125     ASK_SEND_EMAIL: {
 126       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
 127       MAX: config.get<number>('rates_limit.ask_send_email.max')
 128     }
 129   },
 130   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 131   LOG: {
 132     LEVEL: config.get<string>('log.level'),
 133     ROTATION: {
 134       ENABLED: config.get<boolean>('log.rotation.enabled'),
 135       MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.max_file_size')),
 136       MAX_FILES: config.get<number>('log.rotation.max_files')
 137     },
 138     ANONYMIZE_IP: config.get<boolean>('log.anonymize_ip'),
 139     LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
 140     PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
 141   },
 142   TRENDING: {
 143     VIDEOS: {
 144       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
 145       ALGORITHMS: {
 146         get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
 147         get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
 148       }
 149     }
 150   },
 151   REDUNDANCY: {
 152     VIDEOS: {
 153       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 154       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 155     }
 156   },
 157   REMOTE_REDUNDANCY: {
 158     VIDEOS: {
 159       ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
 160     }
 161   },
 162   CSP: {
 163     ENABLED: config.get<boolean>('csp.enabled'),
 164     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 165     REPORT_URI: config.get<string>('csp.report_uri')
 166   },
 167   SECURITY: {
 168     FRAMEGUARD: {
 169       ENABLED: config.get<boolean>('security.frameguard.enabled')
 170     }
 171   },
 172   TRACKER: {
 173     ENABLED: config.get<boolean>('tracker.enabled'),
 174     PRIVATE: config.get<boolean>('tracker.private'),
 175     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 176   },
 177   HISTORY: {
 178     VIDEOS: {
 179       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 180     }
 181   },
 182   VIEWS: {
 183     VIDEOS: {
 184       REMOTE: {
 185         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 186       }
 187     }
 188   },
 189   PLUGINS: {
 190     INDEX: {
 191       ENABLED: config.get<boolean>('plugins.index.enabled'),
 192       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 193       URL: config.get<string>('plugins.index.url')
 194     }
 195   },
 196   FEDERATION: {
 197     VIDEOS: {
 198       FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
 199       CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
 200     }
 201   },
 202   PEERTUBE: {
 203     CHECK_LATEST_VERSION: {
 204       ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
 205       URL: config.get<string>('peertube.check_latest_version.url')
 206     }
 207   },
 208   WEBADMIN: {
 209     CONFIGURATION: {
 210       EDITION: {
 211         ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
 212       }
 213     }
 214   },
 215   ADMIN: {
 216     get EMAIL () { return config.get<string>('admin.email') }
 217   },
 218   CONTACT_FORM: {
 219     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 220   },
 221   SIGNUP: {
 222     get ENABLED () { return config.get<boolean>('signup.enabled') },
 223     get LIMIT () { return config.get<number>('signup.limit') },
 224     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 225     get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
 226     FILTERS: {
 227       CIDR: {
 228         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 229         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 230       }
 231     }
 232   },
 233   USER: {
 234     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 235     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 236   },
 237   TRANSCODING: {
 238     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 239     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 240     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 241     get THREADS () { return config.get<number>('transcoding.threads') },
 242     get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
 243     get PROFILE () { return config.get<string>('transcoding.profile') },
 244     RESOLUTIONS: {
 245       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 246       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 247       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 248       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 249       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 250       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 251       get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
 252       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 253     },
 254     HLS: {
 255       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 256     },
 257     WEBTORRENT: {
 258       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 259     }
 260   },
 261   LIVE: {
 262     get ENABLED () { return config.get<boolean>('live.enabled') },
 263
 264     get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
 265     get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
 266     get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
 267
 268     get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
 269
 270     RTMP: {
 271       get PORT () { return config.get<number>('live.rtmp.port') }
 272     },
 273
 274     TRANSCODING: {
 275       get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
 276       get THREADS () { return config.get<number>('live.transcoding.threads') },
 277       get PROFILE () { return config.get<string>('live.transcoding.profile') },
 278
 279       RESOLUTIONS: {
 280         get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
 281         get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
 282         get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
 283         get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
 284         get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
 285         get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
 286         get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
 287       }
 288     }
 289   },
 290   IMPORT: {
 291     VIDEOS: {
 292       get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
 293
 294       HTTP: {
 295         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 296
 297         YOUTUBE_DL_RELEASE: {
 298           get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
 299           get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') }
 300         },
 301
 302         get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
 303       },
 304       TORRENT: {
 305         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 306       }
 307     }
 308   },
 309   AUTO_BLACKLIST: {
 310     VIDEOS: {
 311       OF_USERS: {
 312         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 313       }
 314     }
 315   },
 316   CACHE: {
 317     PREVIEWS: {
 318       get SIZE () { return config.get<number>('cache.previews.size') }
 319     },
 320     VIDEO_CAPTIONS: {
 321       get SIZE () { return config.get<number>('cache.captions.size') }
 322     },
 323     TORRENTS: {
 324       get SIZE () { return config.get<number>('cache.torrents.size') }
 325     }
 326   },
 327   INSTANCE: {
 328     get NAME () { return config.get<string>('instance.name') },
 329     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 330     get DESCRIPTION () { return config.get<string>('instance.description') },
 331     get TERMS () { return config.get<string>('instance.terms') },
 332     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 333
 334     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 335
 336     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 337     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 338     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 339     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 340     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 341
 342     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 343     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 344
 345     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 346     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 347
 348     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 349
 350     CUSTOMIZATIONS: {
 351       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 352       get CSS () { return config.get<string>('instance.customizations.css') }
 353     },
 354     get ROBOTS () { return config.get<string>('instance.robots') },
 355     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 356     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 357   },
 358   SERVICES: {
 359     TWITTER: {
 360       get USERNAME () { return config.get<string>('services.twitter.username') },
 361       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 362     }
 363   },
 364   FOLLOWERS: {
 365     INSTANCE: {
 366       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 367       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 368     }
 369   },
 370   FOLLOWINGS: {
 371     INSTANCE: {
 372       AUTO_FOLLOW_BACK: {
 373         get ENABLED () {
 374           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 375         }
 376       },
 377       AUTO_FOLLOW_INDEX: {
 378         get ENABLED () {
 379           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 380         },
 381         get INDEX_URL () {
 382           return config.get<string>('followings.instance.auto_follow_index.index_url')
 383         }
 384       }
 385     }
 386   },
 387   THEME: {
 388     get DEFAULT () { return config.get<string>('theme.default') }
 389   },
 390   BROADCAST_MESSAGE: {
 391     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 392     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 393     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 394     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 395   },
 396   SEARCH: {
 397     REMOTE_URI: {
 398       get USERS () { return config.get<boolean>('search.remote_uri.users') },
 399       get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
 400     },
 401     SEARCH_INDEX: {
 402       get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
 403       get URL () { return config.get<string>('search.search_index.url') },
 404       get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
 405       get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
 406     }
 407   }
 408 }
 409
 410 function registerConfigChangedHandler (fun: Function) {
 411   configChangedHandlers.push(fun)
 412 }
 413
 414 function isEmailEnabled () {
 415   if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
 416
 417   if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
 418
 419   return false
 420 }
 421
 422 // ---------------------------------------------------------------------------
 423
 424 export {
 425   CONFIG,
 426   registerConfigChangedHandler,
 427   isEmailEnabled
 428 }
 429
 430 // ---------------------------------------------------------------------------
 431
 432 function getLocalConfigFilePath () {
 433   const localConfigDir = getLocalConfigDir()
 434
 435   let filename = 'local'
 436   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 437   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 438
 439   return join(localConfigDir, filename + '.json')
 440 }
 441
 442 function getLocalConfigDir () {
 443   if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
 444
 445   const configSources = config.util.getConfigSources()
 446   if (configSources.length === 0) throw new Error('Invalid config source.')
 447
 448   return dirname(configSources[0].name)
 449 }
 450
 451 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 452   if (!objs) return []
 453
 454   if (!Array.isArray(objs)) return objs
 455
 456   return objs.map(obj => {
 457     return Object.assign({}, obj, {
 458       minLifetime: parseDurationToMs(obj.min_lifetime),
 459       size: bytes.parse(obj.size),
 460       minViews: obj.min_views
 461     })
 462   })
 463 }
 464
 465 export function reloadConfig () {
 466
 467   function getConfigDirectories () {
 468     if (process.env.NODE_CONFIG_DIR) {
 469       return process.env.NODE_CONFIG_DIR.split(':')
 470     }
 471
 472     return [ join(root(), 'config') ]
 473   }
 474
 475   function purge () {
 476     const directories = getConfigDirectories()
 477
 478     for (const fileName in require.cache) {
 479       if (directories.some((dir) => fileName.includes(dir)) === false) {
 480         continue
 481       }
 482
 483       delete require.cache[fileName]
 484     }
 485
 486     decache('config')
 487   }
 488
 489   purge()
 490
 491   config = require('config')
 492
 493   for (const configChangedHandler of configChangedHandlers) {
 494     configChangedHandler()
 495   }
 496 }