server/initializers/config.ts

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