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     }
 187   },
 188   PLUGINS: {
 189     INDEX: {
 190       ENABLED: config.get<boolean>('plugins.index.enabled'),
 191       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 192       URL: config.get<string>('plugins.index.url')
 193     }
 194   },
 195   FEDERATION: {
 196     VIDEOS: {
 197       FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
 198       CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
 199     }
 200   },
 201   PEERTUBE: {
 202     CHECK_LATEST_VERSION: {
 203       ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
 204       URL: config.get<string>('peertube.check_latest_version.url')
 205     }
 206   },
 207   WEBADMIN: {
 208     CONFIGURATION: {
 209       EDITION: {
 210         ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
 211       }
 212     }
 213   },
 214   ADMIN: {
 215     get EMAIL () { return config.get<string>('admin.email') }
 216   },
 217   CONTACT_FORM: {
 218     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 219   },
 220   SIGNUP: {
 221     get ENABLED () { return config.get<boolean>('signup.enabled') },
 222     get LIMIT () { return config.get<number>('signup.limit') },
 223     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 224     get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
 225     FILTERS: {
 226       CIDR: {
 227         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 228         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 229       }
 230     }
 231   },
 232   USER: {
 233     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 234     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 235   },
 236   TRANSCODING: {
 237     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 238     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 239     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 240     get THREADS () { return config.get<number>('transcoding.threads') },
 241     get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
 242     get PROFILE () { return config.get<string>('transcoding.profile') },
 243     RESOLUTIONS: {
 244       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 245       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 246       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 247       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 248       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 249       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 250       get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
 251       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 252     },
 253     HLS: {
 254       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 255     },
 256     WEBTORRENT: {
 257       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 258     }
 259   },
 260   LIVE: {
 261     get ENABLED () { return config.get<boolean>('live.enabled') },
 262
 263     get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
 264     get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
 265     get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
 266
 267     get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
 268
 269     RTMP: {
 270       get PORT () { return config.get<number>('live.rtmp.port') }
 271     },
 272
 273     TRANSCODING: {
 274       get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
 275       get THREADS () { return config.get<number>('live.transcoding.threads') },
 276       get PROFILE () { return config.get<string>('live.transcoding.profile') },
 277
 278       RESOLUTIONS: {
 279         get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
 280         get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
 281         get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
 282         get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
 283         get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
 284         get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
 285         get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
 286       }
 287     }
 288   },
 289   IMPORT: {
 290     VIDEOS: {
 291       get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
 292
 293       HTTP: {
 294         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 295
 296         YOUTUBE_DL_RELEASE: {
 297           get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
 298           get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') }
 299         },
 300
 301         get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
 302       },
 303       TORRENT: {
 304         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 305       }
 306     }
 307   },
 308   AUTO_BLACKLIST: {
 309     VIDEOS: {
 310       OF_USERS: {
 311         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 312       }
 313     }
 314   },
 315   CACHE: {
 316     PREVIEWS: {
 317       get SIZE () { return config.get<number>('cache.previews.size') }
 318     },
 319     VIDEO_CAPTIONS: {
 320       get SIZE () { return config.get<number>('cache.captions.size') }
 321     },
 322     TORRENTS: {
 323       get SIZE () { return config.get<number>('cache.torrents.size') }
 324     }
 325   },
 326   INSTANCE: {
 327     get NAME () { return config.get<string>('instance.name') },
 328     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 329     get DESCRIPTION () { return config.get<string>('instance.description') },
 330     get TERMS () { return config.get<string>('instance.terms') },
 331     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 332
 333     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 334
 335     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 336     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 337     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 338     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 339     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 340
 341     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 342     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 343
 344     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 345     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 346
 347     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 348
 349     CUSTOMIZATIONS: {
 350       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 351       get CSS () { return config.get<string>('instance.customizations.css') }
 352     },
 353     get ROBOTS () { return config.get<string>('instance.robots') },
 354     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 355     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 356   },
 357   SERVICES: {
 358     TWITTER: {
 359       get USERNAME () { return config.get<string>('services.twitter.username') },
 360       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 361     }
 362   },
 363   FOLLOWERS: {
 364     INSTANCE: {
 365       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 366       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 367     }
 368   },
 369   FOLLOWINGS: {
 370     INSTANCE: {
 371       AUTO_FOLLOW_BACK: {
 372         get ENABLED () {
 373           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 374         }
 375       },
 376       AUTO_FOLLOW_INDEX: {
 377         get ENABLED () {
 378           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 379         },
 380         get INDEX_URL () {
 381           return config.get<string>('followings.instance.auto_follow_index.index_url')
 382         }
 383       }
 384     }
 385   },
 386   THEME: {
 387     get DEFAULT () { return config.get<string>('theme.default') }
 388   },
 389   BROADCAST_MESSAGE: {
 390     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 391     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 392     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 393     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 394   },
 395   SEARCH: {
 396     REMOTE_URI: {
 397       get USERS () { return config.get<boolean>('search.remote_uri.users') },
 398       get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
 399     },
 400     SEARCH_INDEX: {
 401       get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
 402       get URL () { return config.get<string>('search.search_index.url') },
 403       get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
 404       get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
 405     }
 406   }
 407 }
 408
 409 function registerConfigChangedHandler (fun: Function) {
 410   configChangedHandlers.push(fun)
 411 }
 412
 413 function isEmailEnabled () {
 414   if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
 415
 416   if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
 417
 418   return false
 419 }
 420
 421 // ---------------------------------------------------------------------------
 422
 423 export {
 424   CONFIG,
 425   registerConfigChangedHandler,
 426   isEmailEnabled
 427 }
 428
 429 // ---------------------------------------------------------------------------
 430
 431 function getLocalConfigFilePath () {
 432   const localConfigDir = getLocalConfigDir()
 433
 434   let filename = 'local'
 435   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 436   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 437
 438   return join(localConfigDir, filename + '.json')
 439 }
 440
 441 function getLocalConfigDir () {
 442   if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
 443
 444   const configSources = config.util.getConfigSources()
 445   if (configSources.length === 0) throw new Error('Invalid config source.')
 446
 447   return dirname(configSources[0].name)
 448 }
 449
 450 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 451   if (!objs) return []
 452
 453   if (!Array.isArray(objs)) return objs
 454
 455   return objs.map(obj => {
 456     return Object.assign({}, obj, {
 457       minLifetime: parseDurationToMs(obj.min_lifetime),
 458       size: bytes.parse(obj.size),
 459       minViews: obj.min_views
 460     })
 461   })
 462 }
 463
 464 export function reloadConfig () {
 465
 466   function getConfigDirectories () {
 467     if (process.env.NODE_CONFIG_DIR) {
 468       return process.env.NODE_CONFIG_DIR.split(':')
 469     }
 470
 471     return [ join(root(), 'config') ]
 472   }
 473
 474   function purge () {
 475     const directories = getConfigDirectories()
 476
 477     for (const fileName in require.cache) {
 478       if (directories.some((dir) => fileName.includes(dir)) === false) {
 479         continue
 480       }
 481
 482       delete require.cache[fileName]
 483     }
 484
 485     decache('config')
 486   }
 487
 488   purge()
 489
 490   config = require('config')
 491
 492   for (const configChangedHandler of configChangedHandlers) {
 493     configChangedHandler()
 494   }
 495 }