server/initializers/config.ts

   1 import * as 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   STORAGE: {
  62     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
  63     ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
  64     LOG_DIR: buildPath(config.get<string>('storage.logs')),
  65     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
  66     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
  67     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
  68     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
  69     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
  70     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
  71     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
  72     CACHE_DIR: buildPath(config.get<string>('storage.cache')),
  73     PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
  74     CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
  75   },
  76   WEBSERVER: {
  77     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
  78     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
  79     HOSTNAME: config.get<string>('webserver.hostname'),
  80     PORT: config.get<number>('webserver.port')
  81   },
  82   RATES_LIMIT: {
  83     API: {
  84       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
  85       MAX: config.get<number>('rates_limit.api.max')
  86     },
  87     SIGNUP: {
  88       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
  89       MAX: config.get<number>('rates_limit.signup.max')
  90     },
  91     LOGIN: {
  92       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
  93       MAX: config.get<number>('rates_limit.login.max')
  94     },
  95     ASK_SEND_EMAIL: {
  96       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
  97       MAX: config.get<number>('rates_limit.ask_send_email.max')
  98     }
  99   },
 100   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 101   LOG: {
 102     LEVEL: config.get<string>('log.level'),
 103     ROTATION: {
 104       ENABLED: config.get<boolean>('log.rotation.enabled'),
 105       MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.maxFileSize')),
 106       MAX_FILES: config.get<number>('log.rotation.maxFiles')
 107     },
 108     ANONYMIZE_IP: config.get<boolean>('log.anonymizeIP'),
 109     LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
 110     PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
 111   },
 112   TRENDING: {
 113     VIDEOS: {
 114       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
 115       ALGORITHMS: {
 116         get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
 117         get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
 118       }
 119     }
 120   },
 121   REDUNDANCY: {
 122     VIDEOS: {
 123       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 124       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 125     }
 126   },
 127   REMOTE_REDUNDANCY: {
 128     VIDEOS: {
 129       ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
 130     }
 131   },
 132   CSP: {
 133     ENABLED: config.get<boolean>('csp.enabled'),
 134     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 135     REPORT_URI: config.get<string>('csp.report_uri')
 136   },
 137   TRACKER: {
 138     ENABLED: config.get<boolean>('tracker.enabled'),
 139     PRIVATE: config.get<boolean>('tracker.private'),
 140     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 141   },
 142   HISTORY: {
 143     VIDEOS: {
 144       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 145     }
 146   },
 147   VIEWS: {
 148     VIDEOS: {
 149       REMOTE: {
 150         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 151       }
 152     }
 153   },
 154   PLUGINS: {
 155     INDEX: {
 156       ENABLED: config.get<boolean>('plugins.index.enabled'),
 157       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 158       URL: config.get<string>('plugins.index.url')
 159     }
 160   },
 161   FEDERATION: {
 162     VIDEOS: {
 163       FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
 164       CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
 165     }
 166   },
 167   PEERTUBE: {
 168     CHECK_LATEST_VERSION: {
 169       ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
 170       URL: config.get<string>('peertube.check_latest_version.url')
 171     }
 172   },
 173   ADMIN: {
 174     get EMAIL () { return config.get<string>('admin.email') }
 175   },
 176   CONTACT_FORM: {
 177     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 178   },
 179   SIGNUP: {
 180     get ENABLED () { return config.get<boolean>('signup.enabled') },
 181     get LIMIT () { return config.get<number>('signup.limit') },
 182     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 183     FILTERS: {
 184       CIDR: {
 185         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 186         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 187       }
 188     }
 189   },
 190   USER: {
 191     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 192     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 193   },
 194   TRANSCODING: {
 195     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 196     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 197     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 198     get THREADS () { return config.get<number>('transcoding.threads') },
 199     get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
 200     get PROFILE () { return config.get<string>('transcoding.profile') },
 201     RESOLUTIONS: {
 202       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 203       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 204       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 205       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 206       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 207       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 208       get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
 209       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 210     },
 211     HLS: {
 212       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 213     },
 214     WEBTORRENT: {
 215       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 216     }
 217   },
 218   LIVE: {
 219     get ENABLED () { return config.get<boolean>('live.enabled') },
 220
 221     get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
 222     get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
 223     get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
 224
 225     get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
 226
 227     RTMP: {
 228       get PORT () { return config.get<number>('live.rtmp.port') }
 229     },
 230
 231     TRANSCODING: {
 232       get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
 233       get THREADS () { return config.get<number>('live.transcoding.threads') },
 234       get PROFILE () { return config.get<string>('live.transcoding.profile') },
 235
 236       RESOLUTIONS: {
 237         get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
 238         get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
 239         get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
 240         get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
 241         get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
 242         get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
 243         get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
 244       }
 245     }
 246   },
 247   IMPORT: {
 248     VIDEOS: {
 249       get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
 250
 251       HTTP: {
 252         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 253         get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') },
 254         PROXY: {
 255           get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
 256           get URL () { return config.get<string>('import.videos.http.proxy.url') }
 257         }
 258       },
 259       TORRENT: {
 260         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 261       }
 262     }
 263   },
 264   AUTO_BLACKLIST: {
 265     VIDEOS: {
 266       OF_USERS: {
 267         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 268       }
 269     }
 270   },
 271   CACHE: {
 272     PREVIEWS: {
 273       get SIZE () { return config.get<number>('cache.previews.size') }
 274     },
 275     VIDEO_CAPTIONS: {
 276       get SIZE () { return config.get<number>('cache.captions.size') }
 277     },
 278     TORRENTS: {
 279       get SIZE () { return config.get<number>('cache.torrents.size') }
 280     }
 281   },
 282   INSTANCE: {
 283     get NAME () { return config.get<string>('instance.name') },
 284     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 285     get DESCRIPTION () { return config.get<string>('instance.description') },
 286     get TERMS () { return config.get<string>('instance.terms') },
 287     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 288
 289     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 290
 291     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 292     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 293     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 294     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 295     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 296
 297     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 298     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 299
 300     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 301     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 302
 303     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 304
 305     CUSTOMIZATIONS: {
 306       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 307       get CSS () { return config.get<string>('instance.customizations.css') }
 308     },
 309     get ROBOTS () { return config.get<string>('instance.robots') },
 310     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 311     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 312   },
 313   SERVICES: {
 314     TWITTER: {
 315       get USERNAME () { return config.get<string>('services.twitter.username') },
 316       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 317     }
 318   },
 319   FOLLOWERS: {
 320     INSTANCE: {
 321       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 322       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 323     }
 324   },
 325   FOLLOWINGS: {
 326     INSTANCE: {
 327       AUTO_FOLLOW_BACK: {
 328         get ENABLED () {
 329           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 330         }
 331       },
 332       AUTO_FOLLOW_INDEX: {
 333         get ENABLED () {
 334           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 335         },
 336         get INDEX_URL () {
 337           return config.get<string>('followings.instance.auto_follow_index.index_url')
 338         }
 339       }
 340     }
 341   },
 342   THEME: {
 343     get DEFAULT () { return config.get<string>('theme.default') }
 344   },
 345   BROADCAST_MESSAGE: {
 346     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 347     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 348     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 349     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 350   },
 351   SEARCH: {
 352     REMOTE_URI: {
 353       get USERS () { return config.get<boolean>('search.remote_uri.users') },
 354       get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
 355     },
 356     SEARCH_INDEX: {
 357       get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
 358       get URL () { return config.get<string>('search.search_index.url') },
 359       get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
 360       get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
 361     }
 362   }
 363 }
 364
 365 function registerConfigChangedHandler (fun: Function) {
 366   configChangedHandlers.push(fun)
 367 }
 368
 369 function isEmailEnabled () {
 370   if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
 371
 372   if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
 373
 374   return false
 375 }
 376
 377 // ---------------------------------------------------------------------------
 378
 379 export {
 380   CONFIG,
 381   registerConfigChangedHandler,
 382   isEmailEnabled
 383 }
 384
 385 // ---------------------------------------------------------------------------
 386
 387 function getLocalConfigFilePath () {
 388   const configSources = config.util.getConfigSources()
 389   if (configSources.length === 0) throw new Error('Invalid config source.')
 390
 391   let filename = 'local'
 392   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 393   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 394
 395   return join(dirname(configSources[0].name), filename + '.json')
 396 }
 397
 398 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 399   if (!objs) return []
 400
 401   if (!Array.isArray(objs)) return objs
 402
 403   return objs.map(obj => {
 404     return Object.assign({}, obj, {
 405       minLifetime: parseDurationToMs(obj.min_lifetime),
 406       size: bytes.parse(obj.size),
 407       minViews: obj.min_views
 408     })
 409   })
 410 }
 411
 412 export function reloadConfig () {
 413
 414   function getConfigDirectory () {
 415     if (process.env.NODE_CONFIG_DIR) {
 416       return process.env.NODE_CONFIG_DIR
 417     }
 418
 419     return join(root(), 'config')
 420   }
 421
 422   function purge () {
 423     const directory = getConfigDirectory()
 424
 425     for (const fileName in require.cache) {
 426       if (fileName.includes(directory) === false) {
 427         continue
 428       }
 429
 430       delete require.cache[fileName]
 431     }
 432
 433     decache('config')
 434   }
 435
 436   purge()
 437
 438   config = require('config')
 439
 440   for (const configChangedHandler of configChangedHandlers) {
 441     configChangedHandler()
 442   }
 443 }