server/initializers/config.ts

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