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