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