server/initializers/constants.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { JobType, VideoRateType, VideoState } from '../../shared/models'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { FollowState } from '../../shared/models/actors'
   6 import { VideoPrivacy, VideoAbuseState, VideoImportState } from '../../shared/models/videos'
   7 // Do not use barrels, remain constants as independent as possible
   8 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
   9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  10 import { invert } from 'lodash'
  11
  12 // Use a variable to reload the configuration if we need
  13 let config: IConfig = require('config')
  14
  15 // ---------------------------------------------------------------------------
  16
  17 const LAST_MIGRATION_VERSION = 255
  18
  19 // ---------------------------------------------------------------------------
  20
  21 // API version
  22 const API_VERSION = 'v1'
  23
  24 const PAGINATION = {
  25   COUNT: {
  26     DEFAULT: 15,
  27     MAX: 100
  28   }
  29 }
  30
  31 // Sortable columns per schema
  32 const SORTABLE_COLUMNS = {
  33   USERS: [ 'id', 'username', 'createdAt' ],
  34   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  35   ACCOUNTS: [ 'createdAt' ],
  36   JOBS: [ 'createdAt' ],
  37   VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
  38   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  39   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
  40   VIDEO_IMPORTS: [ 'createdAt' ],
  41   VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  42   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  43   FOLLOWERS: [ 'createdAt' ],
  44   FOLLOWING: [ 'createdAt' ],
  45
  46   VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
  47   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName' ]
  48 }
  49
  50 const OAUTH_LIFETIME = {
  51   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  52   REFRESH_TOKEN: 1209600 // 2 weeks
  53 }
  54
  55 const ROUTE_CACHE_LIFETIME = {
  56   FEEDS: '15 minutes',
  57   ROBOTS: '2 hours',
  58   NODEINFO: '10 minutes',
  59   DNT_POLICY: '1 week',
  60   ACTIVITY_PUB: {
  61     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  62   }
  63 }
  64
  65 // ---------------------------------------------------------------------------
  66
  67 // Number of points we add/remove after a successful/bad request
  68 const ACTOR_FOLLOW_SCORE = {
  69   PENALTY: -10,
  70   BONUS: 10,
  71   BASE: 1000,
  72   MAX: 10000
  73 }
  74
  75 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  76   PENDING: 'pending',
  77   ACCEPTED: 'accepted'
  78 }
  79
  80 const REMOTE_SCHEME = {
  81   HTTP: 'https',
  82   WS: 'wss'
  83 }
  84
  85 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
  86   'activitypub-http-broadcast': 5,
  87   'activitypub-http-unicast': 5,
  88   'activitypub-http-fetcher': 5,
  89   'activitypub-follow': 5,
  90   'video-file-import': 1,
  91   'video-file': 1,
  92   'video-import': 1,
  93   'email': 5
  94 }
  95 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
  96   'activitypub-http-broadcast': 1,
  97   'activitypub-http-unicast': 5,
  98   'activitypub-http-fetcher': 1,
  99   'activitypub-follow': 3,
 100   'video-file-import': 1,
 101   'video-file': 1,
 102   'video-import': 1,
 103   'email': 5
 104 }
 105 const JOB_TTL: { [ id in JobType ]: number } = {
 106   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 107   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 108   'activitypub-http-fetcher': 60000 * 10, // 10 minutes
 109   'activitypub-follow': 60000 * 10, // 10 minutes
 110   'video-file-import': 1000 * 3600, // 1 hour
 111   'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
 112   'video-import': 1000 * 3600 * 5, // 5 hours
 113   'email': 60000 * 10 // 10 minutes
 114 }
 115 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 116 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 117 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
 118 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 119
 120 // 1 hour
 121 let SCHEDULER_INTERVALS_MS = {
 122   badActorFollow: 60000 * 60, // 1 hour
 123   removeOldJobs: 60000 * 60, // 1 hour
 124   updateVideos: 60000, // 1 minute
 125   youtubeDLUpdate: 60000 * 60 * 24 // 1 day
 126 }
 127
 128 // ---------------------------------------------------------------------------
 129
 130 const CONFIG = {
 131   CUSTOM_FILE: getLocalConfigFilePath(),
 132   LISTEN: {
 133     PORT: config.get<number>('listen.port'),
 134     HOSTNAME: config.get<string>('listen.hostname')
 135   },
 136   DATABASE: {
 137     DBNAME: 'peertube' + config.get<string>('database.suffix'),
 138     HOSTNAME: config.get<string>('database.hostname'),
 139     PORT: config.get<number>('database.port'),
 140     USERNAME: config.get<string>('database.username'),
 141     PASSWORD: config.get<string>('database.password'),
 142     POOL: {
 143       MAX: config.get<number>('database.pool.max')
 144     }
 145   },
 146   REDIS: {
 147     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
 148     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
 149     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
 150     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
 151     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
 152   },
 153   SMTP: {
 154     HOSTNAME: config.get<string>('smtp.hostname'),
 155     PORT: config.get<number>('smtp.port'),
 156     USERNAME: config.get<string>('smtp.username'),
 157     PASSWORD: config.get<string>('smtp.password'),
 158     TLS: config.get<boolean>('smtp.tls'),
 159     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
 160     CA_FILE: config.get<string>('smtp.ca_file'),
 161     FROM_ADDRESS: config.get<string>('smtp.from_address')
 162   },
 163   STORAGE: {
 164     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
 165     LOG_DIR: buildPath(config.get<string>('storage.logs')),
 166     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
 167     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
 168     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
 169     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
 170     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
 171     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
 172   },
 173   WEBSERVER: {
 174     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 175     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 176     HOSTNAME: config.get<string>('webserver.hostname'),
 177     PORT: config.get<number>('webserver.port'),
 178     URL: '',
 179     HOST: ''
 180   },
 181   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 182   LOG: {
 183     LEVEL: config.get<string>('log.level')
 184   },
 185   SEARCH: {
 186     REMOTE_URI: {
 187       USERS: config.get<boolean>('search.remote_uri.users'),
 188       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 189     }
 190   },
 191   ADMIN: {
 192     get EMAIL () { return config.get<string>('admin.email') }
 193   },
 194   SIGNUP: {
 195     get ENABLED () { return config.get<boolean>('signup.enabled') },
 196     get LIMIT () { return config.get<number>('signup.limit') },
 197     FILTERS: {
 198       CIDR: {
 199         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 200         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 201       }
 202     }
 203   },
 204   USER: {
 205     get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
 206   },
 207   TRANSCODING: {
 208     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 209     get THREADS () { return config.get<number>('transcoding.threads') },
 210     RESOLUTIONS: {
 211       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 212       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 213       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 214       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 215       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 216     }
 217   },
 218   IMPORT: {
 219     VIDEOS: {
 220       HTTP: {
 221         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 222       },
 223       TORRENT: {
 224         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 225       }
 226     }
 227   },
 228   CACHE: {
 229     PREVIEWS: {
 230       get SIZE () { return config.get<number>('cache.previews.size') }
 231     },
 232     VIDEO_CAPTIONS: {
 233       get SIZE () { return config.get<number>('cache.captions.size') }
 234     }
 235   },
 236   INSTANCE: {
 237     get NAME () { return config.get<string>('instance.name') },
 238     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 239     get DESCRIPTION () { return config.get<string>('instance.description') },
 240     get TERMS () { return config.get<string>('instance.terms') },
 241     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 242     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 243     CUSTOMIZATIONS: {
 244       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 245       get CSS () { return config.get<string>('instance.customizations.css') }
 246     },
 247     get ROBOTS () { return config.get<string>('instance.robots') }
 248   },
 249   SERVICES: {
 250     TWITTER: {
 251       get USERNAME () { return config.get<string>('services.twitter.username') },
 252       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 253     }
 254   }
 255 }
 256
 257 // ---------------------------------------------------------------------------
 258
 259 const CONSTRAINTS_FIELDS = {
 260   USERS: {
 261     NAME: { min: 3, max: 120 }, // Length
 262     DESCRIPTION: { min: 3, max: 250 }, // Length
 263     USERNAME: { min: 3, max: 20 }, // Length
 264     PASSWORD: { min: 6, max: 255 }, // Length
 265     VIDEO_QUOTA: { min: -1 },
 266     BLOCKED_REASON: { min: 3, max: 250 } // Length
 267   },
 268   VIDEO_ABUSES: {
 269     REASON: { min: 2, max: 300 }, // Length
 270     MODERATION_COMMENT: { min: 2, max: 300 } // Length
 271   },
 272   VIDEO_BLACKLIST: {
 273     REASON: { min: 2, max: 300 } // Length
 274   },
 275   VIDEO_CHANNELS: {
 276     NAME: { min: 3, max: 120 }, // Length
 277     DESCRIPTION: { min: 3, max: 500 }, // Length
 278     SUPPORT: { min: 3, max: 500 }, // Length
 279     URL: { min: 3, max: 2000 } // Length
 280   },
 281   VIDEO_CAPTIONS: {
 282     CAPTION_FILE: {
 283       EXTNAME: [ '.vtt', '.srt' ],
 284       FILE_SIZE: {
 285         max: 2 * 1024 * 1024 // 2MB
 286       }
 287     }
 288   },
 289   VIDEO_IMPORTS: {
 290     URL: { min: 3, max: 2000 }, // Length
 291     TORRENT_NAME: { min: 3, max: 255 }, // Length
 292     TORRENT_FILE: {
 293       EXTNAME: [ '.torrent' ],
 294       FILE_SIZE: {
 295         max: 1024 * 200 // 200 KB
 296       }
 297     }
 298   },
 299   VIDEOS: {
 300     NAME: { min: 3, max: 120 }, // Length
 301     LANGUAGE: { min: 1, max: 10 }, // Length
 302     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 303     DESCRIPTION: { min: 3, max: 10000 }, // Length
 304     SUPPORT: { min: 3, max: 500 }, // Length
 305     IMAGE: {
 306       EXTNAME: [ '.jpg', '.jpeg' ],
 307       FILE_SIZE: {
 308         max: 2 * 1024 * 1024 // 2MB
 309       }
 310     },
 311     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 312     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 313     DURATION: { min: 0 }, // Number
 314     TAGS: { min: 0, max: 5 }, // Number of total tags
 315     TAG: { min: 2, max: 30 }, // Length
 316     THUMBNAIL: { min: 2, max: 30 },
 317     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 318     VIEWS: { min: 0 },
 319     LIKES: { min: 0 },
 320     DISLIKES: { min: 0 },
 321     FILE_SIZE: { min: 10 },
 322     URL: { min: 3, max: 2000 } // Length
 323   },
 324   ACTORS: {
 325     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 326     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 327     URL: { min: 3, max: 2000 }, // Length
 328     AVATAR: {
 329       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 330       FILE_SIZE: {
 331         max: 2 * 1024 * 1024 // 2MB
 332       }
 333     }
 334   },
 335   VIDEO_EVENTS: {
 336     COUNT: { min: 0 }
 337   },
 338   VIDEO_COMMENTS: {
 339     TEXT: { min: 1, max: 3000 }, // Length
 340     URL: { min: 3, max: 2000 } // Length
 341   },
 342   VIDEO_SHARE: {
 343     URL: { min: 3, max: 2000 } // Length
 344   }
 345 }
 346
 347 const RATES_LIMIT = {
 348   LOGIN: {
 349     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 350     MAX: 15 // 15 attempts
 351   }
 352 }
 353
 354 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 355 const VIDEO_TRANSCODING_FPS = {
 356   MIN: 10,
 357   AVERAGE: 30,
 358   MAX: 60,
 359   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 360 }
 361
 362 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 363   LIKE: 'like',
 364   DISLIKE: 'dislike'
 365 }
 366
 367 const FFMPEG_NICE: { [ id: string ]: number } = {
 368   THUMBNAIL: 2, // 2 just for don't blocking servers
 369   TRANSCODING: 15
 370 }
 371
 372 const VIDEO_CATEGORIES = {
 373   1: 'Music',
 374   2: 'Films',
 375   3: 'Vehicles',
 376   4: 'Art',
 377   5: 'Sports',
 378   6: 'Travels',
 379   7: 'Gaming',
 380   8: 'People',
 381   9: 'Comedy',
 382   10: 'Entertainment',
 383   11: 'News',
 384   12: 'How To',
 385   13: 'Education',
 386   14: 'Activism',
 387   15: 'Science & Technology',
 388   16: 'Animals',
 389   17: 'Kids',
 390   18: 'Food'
 391 }
 392
 393 // See https://creativecommons.org/licenses/?lang=en
 394 const VIDEO_LICENCES = {
 395   1: 'Attribution',
 396   2: 'Attribution - Share Alike',
 397   3: 'Attribution - No Derivatives',
 398   4: 'Attribution - Non Commercial',
 399   5: 'Attribution - Non Commercial - Share Alike',
 400   6: 'Attribution - Non Commercial - No Derivatives',
 401   7: 'Public Domain Dedication'
 402 }
 403
 404 const VIDEO_LANGUAGES = buildLanguages()
 405
 406 const VIDEO_PRIVACIES = {
 407   [VideoPrivacy.PUBLIC]: 'Public',
 408   [VideoPrivacy.UNLISTED]: 'Unlisted',
 409   [VideoPrivacy.PRIVATE]: 'Private'
 410 }
 411
 412 const VIDEO_STATES = {
 413   [VideoState.PUBLISHED]: 'Published',
 414   [VideoState.TO_TRANSCODE]: 'To transcode',
 415   [VideoState.TO_IMPORT]: 'To import'
 416 }
 417
 418 const VIDEO_IMPORT_STATES = {
 419   [VideoImportState.FAILED]: 'Failed',
 420   [VideoImportState.PENDING]: 'Pending',
 421   [VideoImportState.SUCCESS]: 'Success'
 422 }
 423
 424 const VIDEO_ABUSE_STATES = {
 425   [VideoAbuseState.PENDING]: 'Pending',
 426   [VideoAbuseState.REJECTED]: 'Rejected',
 427   [VideoAbuseState.ACCEPTED]: 'Accepted'
 428 }
 429
 430 const VIDEO_MIMETYPE_EXT = {
 431   'video/webm': '.webm',
 432   'video/ogg': '.ogv',
 433   'video/mp4': '.mp4'
 434 }
 435 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
 436
 437 const IMAGE_MIMETYPE_EXT = {
 438   'image/png': '.png',
 439   'image/jpg': '.jpg',
 440   'image/jpeg': '.jpg'
 441 }
 442
 443 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
 444   'text/vtt': '.vtt',
 445   'application/x-subrip': '.srt'
 446 }
 447
 448 const TORRENT_MIMETYPE_EXT = {
 449   'application/x-bittorrent': '.torrent'
 450 }
 451
 452 // ---------------------------------------------------------------------------
 453
 454 const SERVER_ACTOR_NAME = 'peertube'
 455
 456 const ACTIVITY_PUB = {
 457   POTENTIAL_ACCEPT_HEADERS: [
 458     'application/activity+json',
 459     'application/ld+json',
 460     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 461   ],
 462   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 463   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 464   COLLECTION_ITEMS_PER_PAGE: 10,
 465   FETCH_PAGE_LIMIT: 100,
 466   URL_MIME_TYPES: {
 467     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 468     TORRENT: [ 'application/x-bittorrent' ],
 469     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 470   },
 471   MAX_RECURSION_COMMENTS: 100,
 472   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
 473   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 474 }
 475
 476 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 477   GROUP: 'Group',
 478   PERSON: 'Person',
 479   APPLICATION: 'Application'
 480 }
 481
 482 // ---------------------------------------------------------------------------
 483
 484 const PRIVATE_RSA_KEY_SIZE = 2048
 485
 486 // Password encryption
 487 const BCRYPT_SALT_SIZE = 10
 488
 489 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 490
 491 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 492   DO_NOT_LIST: 'do_not_list',
 493   BLUR: 'blur',
 494   DISPLAY: 'display'
 495 }
 496
 497 // ---------------------------------------------------------------------------
 498
 499 // Express static paths (router)
 500 const STATIC_PATHS = {
 501   PREVIEWS: '/static/previews/',
 502   THUMBNAILS: '/static/thumbnails/',
 503   TORRENTS: '/static/torrents/',
 504   WEBSEED: '/static/webseed/',
 505   AVATARS: '/static/avatars/',
 506   VIDEO_CAPTIONS: '/static/video-captions/'
 507 }
 508 const STATIC_DOWNLOAD_PATHS = {
 509   TORRENTS: '/download/torrents/',
 510   VIDEOS: '/download/videos/'
 511 }
 512
 513 // Cache control
 514 let STATIC_MAX_AGE = '2h'
 515
 516 // Videos thumbnail size
 517 const THUMBNAILS_SIZE = {
 518   width: 200,
 519   height: 110
 520 }
 521 const PREVIEWS_SIZE = {
 522   width: 560,
 523   height: 315
 524 }
 525 const AVATARS_SIZE = {
 526   width: 120,
 527   height: 120
 528 }
 529
 530 const EMBED_SIZE = {
 531   width: 560,
 532   height: 315
 533 }
 534
 535 // Sub folders of cache directory
 536 const CACHE = {
 537   PREVIEWS: {
 538     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 539     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 540   },
 541   VIDEO_CAPTIONS: {
 542     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 543     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 544   }
 545 }
 546
 547 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 548
 549 // ---------------------------------------------------------------------------
 550
 551 const CUSTOM_HTML_TAG_COMMENTS = {
 552   TITLE: '<!-- title tag -->',
 553   DESCRIPTION: '<!-- description tag -->',
 554   CUSTOM_CSS: '<!-- custom css tag -->',
 555   OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
 556 }
 557
 558 // ---------------------------------------------------------------------------
 559
 560 const FEEDS = {
 561   COUNT: 20
 562 }
 563
 564 // ---------------------------------------------------------------------------
 565
 566 const TRACKER_RATE_LIMITS = {
 567   INTERVAL: 60000 * 5, // 5 minutes
 568   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 569   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 570 }
 571
 572 // ---------------------------------------------------------------------------
 573
 574 // Special constants for a test instance
 575 if (isTestInstance() === true) {
 576   ACTOR_FOLLOW_SCORE.BASE = 20
 577
 578   REMOTE_SCHEME.HTTP = 'http'
 579   REMOTE_SCHEME.WS = 'ws'
 580
 581   STATIC_MAX_AGE = '0'
 582
 583   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 584   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 585   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 586
 587   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 588
 589   SCHEDULER_INTERVALS_MS.badActorFollow = 10000
 590   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 591   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 592
 593   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 594
 595   JOB_ATTEMPTS['email'] = 1
 596
 597   CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 598 }
 599
 600 updateWebserverConfig()
 601
 602 // ---------------------------------------------------------------------------
 603
 604 export {
 605   API_VERSION,
 606   VIDEO_CAPTIONS_MIMETYPE_EXT,
 607   AVATARS_SIZE,
 608   ACCEPT_HEADERS,
 609   BCRYPT_SALT_SIZE,
 610   TRACKER_RATE_LIMITS,
 611   CACHE,
 612   CONFIG,
 613   CONSTRAINTS_FIELDS,
 614   EMBED_SIZE,
 615   JOB_CONCURRENCY,
 616   JOB_ATTEMPTS,
 617   LAST_MIGRATION_VERSION,
 618   OAUTH_LIFETIME,
 619   CUSTOM_HTML_TAG_COMMENTS,
 620   BROADCAST_CONCURRENCY,
 621   PAGINATION,
 622   ACTOR_FOLLOW_SCORE,
 623   PREVIEWS_SIZE,
 624   REMOTE_SCHEME,
 625   FOLLOW_STATES,
 626   SERVER_ACTOR_NAME,
 627   PRIVATE_RSA_KEY_SIZE,
 628   ROUTE_CACHE_LIFETIME,
 629   SORTABLE_COLUMNS,
 630   FEEDS,
 631   JOB_TTL,
 632   NSFW_POLICY_TYPES,
 633   TORRENT_MIMETYPE_EXT,
 634   STATIC_MAX_AGE,
 635   STATIC_PATHS,
 636   ACTIVITY_PUB,
 637   ACTIVITY_PUB_ACTOR_TYPES,
 638   THUMBNAILS_SIZE,
 639   VIDEO_CATEGORIES,
 640   VIDEO_LANGUAGES,
 641   VIDEO_PRIVACIES,
 642   VIDEO_LICENCES,
 643   VIDEO_STATES,
 644   VIDEO_RATE_TYPES,
 645   VIDEO_MIMETYPE_EXT,
 646   VIDEO_TRANSCODING_FPS,
 647   FFMPEG_NICE,
 648   VIDEO_ABUSE_STATES,
 649   JOB_REQUEST_TIMEOUT,
 650   USER_PASSWORD_RESET_LIFETIME,
 651   IMAGE_MIMETYPE_EXT,
 652   SCHEDULER_INTERVALS_MS,
 653   STATIC_DOWNLOAD_PATHS,
 654   RATES_LIMIT,
 655   VIDEO_EXT_MIMETYPE,
 656   CRAWL_REQUEST_CONCURRENCY,
 657   JOB_COMPLETED_LIFETIME,
 658   VIDEO_IMPORT_STATES,
 659   VIDEO_VIEW_LIFETIME,
 660   buildLanguages
 661 }
 662
 663 // ---------------------------------------------------------------------------
 664
 665 function getLocalConfigFilePath () {
 666   const configSources = config.util.getConfigSources()
 667   if (configSources.length === 0) throw new Error('Invalid config source.')
 668
 669   let filename = 'local'
 670   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 671   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 672
 673   return join(dirname(configSources[ 0 ].name), filename + '.json')
 674 }
 675
 676 function updateWebserverConfig () {
 677   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 678   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 679 }
 680
 681 function buildLanguages () {
 682   const iso639 = require('iso-639-3')
 683
 684   const languages: { [ id: string ]: string } = {}
 685
 686   const additionalLanguages = {
 687     'sgn': true, // Sign languages (macro language)
 688     'ase': true, // American sign language
 689     'sdl': true, // Arabian sign language
 690     'bfi': true, // British sign language
 691     'bzs': true, // Brazilian sign language
 692     'csl': true, // Chinese sign language
 693     'cse': true, // Czech sign language
 694     'dsl': true, // Danish sign language
 695     'fsl': true, // French sign language
 696     'gsg': true, // German sign language
 697     'pks': true, // Pakistan sign language
 698     'jsl': true, // Japanese sign language
 699     'sfs': true, // South African sign language
 700     'swl': true, // Swedish sign language
 701     'rsl': true, // Russian sign language: true
 702
 703     'epo': true, // Esperanto
 704     'tlh': true, // Klingon
 705     'jbo': true, // Lojban
 706     'avk': true // Kotava
 707   }
 708
 709   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 710   iso639
 711     .filter(l => {
 712       return (l.iso6391 !== null && l.type === 'living') ||
 713         additionalLanguages[l.iso6393] === true
 714     })
 715     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 716
 717   return languages
 718 }
 719
 720 export function reloadConfig () {
 721
 722   function directory () {
 723     if (process.env.NODE_CONFIG_DIR) {
 724       return process.env.NODE_CONFIG_DIR
 725     }
 726
 727     return join(root(), 'config')
 728   }
 729
 730   function purge () {
 731     for (const fileName in require.cache) {
 732       if (-1 === fileName.indexOf(directory())) {
 733         continue
 734       }
 735
 736       delete require.cache[fileName]
 737     }
 738
 739     delete require.cache[require.resolve('config')]
 740   }
 741
 742   purge()
 743
 744   config = require('config')
 745
 746   updateWebserverConfig()
 747 }