1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType, VideoState, VideosRedundancy } from '../../shared/models'
4 import { ActivityPubActorType } from '../../shared/models/activitypub'
5 import { FollowState } from '../../shared/models/actors'
6 import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
7 // Do not use barrels, remain constants as independent as possible
8 import { buildPath, isTestInstance, parseDuration, parseBytes, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
10 import { invert } from 'lodash'
11 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
12 import * as bytes from 'bytes'
13 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
14 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
16 // Use a variable to reload the configuration if we need
17 let config: IConfig = require('config')
19 // ---------------------------------------------------------------------------
21 const LAST_MIGRATION_VERSION = 360
23 // ---------------------------------------------------------------------------
26 const API_VERSION = 'v1'
35 // Sortable columns per schema
36 const SORTABLE_COLUMNS = {
37 USERS: [ 'id', 'username', 'createdAt' ],
38 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
39 ACCOUNTS: [ 'createdAt' ],
40 JOBS: [ 'createdAt' ],
41 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
42 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
43 VIDEO_IMPORTS: [ 'createdAt' ],
44 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
45 VIDEO_RATES: [ 'createdAt' ],
46 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
47 FOLLOWERS: [ 'createdAt' ],
48 FOLLOWING: [ 'createdAt' ],
50 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
52 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
53 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
55 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
56 SERVERS_BLOCKLIST: [ 'createdAt' ],
58 USER_NOTIFICATIONS: [ 'createdAt' ],
60 VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
63 const OAUTH_LIFETIME = {
64 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
65 REFRESH_TOKEN: 1209600 // 2 weeks
68 const ROUTE_CACHE_LIFETIME = {
72 SECURITYTXT: '2 hours',
73 NODEINFO: '10 minutes',
79 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
84 // ---------------------------------------------------------------------------
86 // Number of points we add/remove after a successful/bad request
87 const ACTOR_FOLLOW_SCORE = {
94 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
99 const REMOTE_SCHEME = {
104 // TODO: remove 'video-file'
105 const JOB_ATTEMPTS: { [ id in (JobType | 'video-file') ]: number } = {
106 'activitypub-http-broadcast': 5,
107 'activitypub-http-unicast': 5,
108 'activitypub-http-fetcher': 5,
109 'activitypub-follow': 5,
110 'video-file-import': 1,
111 'video-transcoding': 1,
116 'activitypub-refresher': 1
118 const JOB_CONCURRENCY: { [ id in (JobType | 'video-file') ]: number } = {
119 'activitypub-http-broadcast': 1,
120 'activitypub-http-unicast': 5,
121 'activitypub-http-fetcher': 1,
122 'activitypub-follow': 3,
123 'video-file-import': 1,
124 'video-transcoding': 1,
129 'activitypub-refresher': 1
131 const JOB_TTL: { [ id in (JobType | 'video-file') ]: number } = {
132 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
133 'activitypub-http-unicast': 60000 * 10, // 10 minutes
134 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
135 'activitypub-follow': 60000 * 10, // 10 minutes
136 'video-file-import': 1000 * 3600, // 1 hour
137 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
138 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
139 'video-import': 1000 * 3600 * 2, // hours
140 'email': 60000 * 10, // 10 minutes
141 'videos-views': undefined, // Unlimited
142 'activitypub-refresher': 60000 * 10 // 10 minutes
144 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
146 cron: '1 * * * *' // At 1 minute past the hour
150 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
151 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
152 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
153 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
154 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
157 let SCHEDULER_INTERVALS_MS = {
158 actorFollowScores: 60000 * 60, // 1 hour
159 removeOldJobs: 60000 * 60, // 1 hour
160 updateVideos: 60000, // 1 minute
161 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
164 // ---------------------------------------------------------------------------
167 CUSTOM_FILE: getLocalConfigFilePath(),
169 PORT: config.get<number>('listen.port'),
170 HOSTNAME: config.get<string>('listen.hostname')
173 DBNAME: 'peertube' + config.get<string>('database.suffix'),
174 HOSTNAME: config.get<string>('database.hostname'),
175 PORT: config.get<number>('database.port'),
176 USERNAME: config.get<string>('database.username'),
177 PASSWORD: config.get<string>('database.password'),
179 MAX: config.get<number>('database.pool.max')
183 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
184 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
185 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
186 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
187 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
190 HOSTNAME: config.get<string>('smtp.hostname'),
191 PORT: config.get<number>('smtp.port'),
192 USERNAME: config.get<string>('smtp.username'),
193 PASSWORD: config.get<string>('smtp.password'),
194 TLS: config.get<boolean>('smtp.tls'),
195 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
196 CA_FILE: config.get<string>('smtp.ca_file'),
197 FROM_ADDRESS: config.get<string>('smtp.from_address')
200 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
201 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
202 LOG_DIR: buildPath(config.get<string>('storage.logs')),
203 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
204 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
205 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
206 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
207 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
208 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
209 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
210 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
213 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
214 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
215 HOSTNAME: config.get<string>('webserver.hostname'),
216 PORT: config.get<number>('webserver.port'),
220 TRUST_PROXY: config.get<string[]>('trust_proxy'),
222 LEVEL: config.get<string>('log.level')
226 USERS: config.get<boolean>('search.remote_uri.users'),
227 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
232 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
237 CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
238 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
242 ENABLED: config.get<boolean>('csp.enabled'),
243 REPORT_ONLY: config.get<boolean>('csp.report_only'),
244 REPORT_URI: config.get<boolean>('csp.report_uri')
247 ENABLED: config.get<boolean>('tracker.enabled'),
248 PRIVATE: config.get<boolean>('tracker.private'),
249 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
252 get EMAIL () { return config.get<string>('admin.email') }
255 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
258 get ENABLED () { return config.get<boolean>('signup.enabled') },
259 get LIMIT () { return config.get<number>('signup.limit') },
260 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
263 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
264 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
269 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
270 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
273 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
274 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
275 get THREADS () { return config.get<number>('transcoding.threads') },
277 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
278 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
279 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
280 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
281 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
284 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
290 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
293 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
300 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
306 get SIZE () { return config.get<number>('cache.previews.size') }
309 get SIZE () { return config.get<number>('cache.captions.size') }
313 get NAME () { return config.get<string>('instance.name') },
314 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
315 get DESCRIPTION () { return config.get<string>('instance.description') },
316 get TERMS () { return config.get<string>('instance.terms') },
317 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
318 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
319 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
321 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
322 get CSS () { return config.get<string>('instance.customizations.css') }
324 get ROBOTS () { return config.get<string>('instance.robots') },
325 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
326 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
330 get USERNAME () { return config.get<string>('services.twitter.username') },
331 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
336 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
337 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
342 // ---------------------------------------------------------------------------
344 let CONSTRAINTS_FIELDS = {
346 NAME: { min: 1, max: 120 }, // Length
347 DESCRIPTION: { min: 3, max: 1000 }, // Length
348 USERNAME: { min: 1, max: 50 }, // Length
349 PASSWORD: { min: 6, max: 255 }, // Length
350 VIDEO_QUOTA: { min: -1 },
351 VIDEO_QUOTA_DAILY: { min: -1 },
352 BLOCKED_REASON: { min: 3, max: 250 } // Length
355 REASON: { min: 2, max: 3000 }, // Length
356 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
359 REASON: { min: 2, max: 300 } // Length
362 NAME: { min: 1, max: 120 }, // Length
363 DESCRIPTION: { min: 3, max: 1000 }, // Length
364 SUPPORT: { min: 3, max: 1000 }, // Length
365 URL: { min: 3, max: 2000 } // Length
369 EXTNAME: [ '.vtt', '.srt' ],
371 max: 2 * 1024 * 1024 // 2MB
376 URL: { min: 3, max: 2000 }, // Length
377 TORRENT_NAME: { min: 3, max: 255 }, // Length
379 EXTNAME: [ '.torrent' ],
381 max: 1024 * 200 // 200 KB
386 URL: { min: 3, max: 2000 } // Length
389 URL: { min: 3, max: 2000 } // Length
392 NAME: { min: 3, max: 120 }, // Length
393 LANGUAGE: { min: 1, max: 10 }, // Length
394 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
395 DESCRIPTION: { min: 3, max: 10000 }, // Length
396 SUPPORT: { min: 3, max: 1000 }, // Length
398 EXTNAME: [ '.jpg', '.jpeg' ],
400 max: 2 * 1024 * 1024 // 2MB
403 EXTNAME: buildVideosExtname(),
404 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
405 DURATION: { min: 0 }, // Number
406 TAGS: { min: 0, max: 5 }, // Number of total tags
407 TAG: { min: 2, max: 30 }, // Length
408 THUMBNAIL: { min: 2, max: 30 },
409 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
412 DISLIKES: { min: 0 },
413 FILE_SIZE: { min: 10 },
414 URL: { min: 3, max: 2000 } // Length
417 NAME: { min: 1, max: 120 }, // Length
418 DESCRIPTION: { min: 3, max: 1000 }, // Length
419 URL: { min: 3, max: 2000 }, // Length
421 EXTNAME: [ '.jpg', '.jpeg' ],
423 max: 2 * 1024 * 1024 // 2MB
428 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
429 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
430 URL: { min: 3, max: 2000 }, // Length
432 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
434 max: 2 * 1024 * 1024 // 2MB
442 TEXT: { min: 1, max: 3000 }, // Length
443 URL: { min: 3, max: 2000 } // Length
446 URL: { min: 3, max: 2000 } // Length
449 FROM_NAME: { min: 1, max: 120 }, // Length
450 BODY: { min: 3, max: 5000 } // Length
454 const RATES_LIMIT = {
456 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
457 MAX: 15 // 15 attempts
460 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
465 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
466 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
468 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
472 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
475 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
480 const FFMPEG_NICE: { [ id: string ]: number } = {
481 THUMBNAIL: 2, // 2 just for don't blocking servers
485 const VIDEO_CATEGORIES = {
496 11: 'News & Politics',
500 15: 'Science & Technology',
506 // See https://creativecommons.org/licenses/?lang=en
507 const VIDEO_LICENCES = {
509 2: 'Attribution - Share Alike',
510 3: 'Attribution - No Derivatives',
511 4: 'Attribution - Non Commercial',
512 5: 'Attribution - Non Commercial - Share Alike',
513 6: 'Attribution - Non Commercial - No Derivatives',
514 7: 'Public Domain Dedication'
517 const VIDEO_LANGUAGES = buildLanguages()
519 const VIDEO_PRIVACIES = {
520 [VideoPrivacy.PUBLIC]: 'Public',
521 [VideoPrivacy.UNLISTED]: 'Unlisted',
522 [VideoPrivacy.PRIVATE]: 'Private'
525 const VIDEO_STATES = {
526 [VideoState.PUBLISHED]: 'Published',
527 [VideoState.TO_TRANSCODE]: 'To transcode',
528 [VideoState.TO_IMPORT]: 'To import'
531 const VIDEO_IMPORT_STATES = {
532 [VideoImportState.FAILED]: 'Failed',
533 [VideoImportState.PENDING]: 'Pending',
534 [VideoImportState.SUCCESS]: 'Success'
537 const VIDEO_ABUSE_STATES = {
538 [VideoAbuseState.PENDING]: 'Pending',
539 [VideoAbuseState.REJECTED]: 'Rejected',
540 [VideoAbuseState.ACCEPTED]: 'Accepted'
543 const VIDEO_PLAYLIST_PRIVACIES = {
544 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
545 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
546 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
549 const VIDEO_PLAYLIST_TYPES = {
550 [VideoPlaylistType.REGULAR]: 'Regular',
551 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
556 MIMETYPE_EXT: buildVideoMimetypeExt(),
557 EXT_MIMETYPE: null as { [ id: string ]: string }
569 'application/x-subrip': '.srt'
574 'application/x-bittorrent': '.torrent'
578 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
580 // ---------------------------------------------------------------------------
589 // ---------------------------------------------------------------------------
591 const SERVER_ACTOR_NAME = 'peertube'
593 const ACTIVITY_PUB = {
594 POTENTIAL_ACCEPT_HEADERS: [
595 'application/activity+json',
596 'application/ld+json',
597 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
599 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
600 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
601 COLLECTION_ITEMS_PER_PAGE: 10,
602 FETCH_PAGE_LIMIT: 100,
604 VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
605 TORRENT: [ 'application/x-bittorrent' ],
606 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
608 MAX_RECURSION_COMMENTS: 100,
609 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
610 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
611 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
614 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
617 APPLICATION: 'Application'
620 const HTTP_SIGNATURE = {
621 HEADER_NAME: 'signature',
622 ALGORITHM: 'rsa-sha256',
623 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
626 // ---------------------------------------------------------------------------
628 let PRIVATE_RSA_KEY_SIZE = 2048
630 // Password encryption
631 const BCRYPT_SALT_SIZE = 10
633 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
635 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
637 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
638 DO_NOT_LIST: 'do_not_list',
643 // ---------------------------------------------------------------------------
645 // Express static paths (router)
646 const STATIC_PATHS = {
647 PREVIEWS: '/static/previews/',
648 THUMBNAILS: '/static/thumbnails/',
649 TORRENTS: '/static/torrents/',
650 WEBSEED: '/static/webseed/',
651 REDUNDANCY: '/static/redundancy/',
652 STREAMING_PLAYLISTS: {
653 HLS: '/static/streaming-playlists/hls'
655 AVATARS: '/static/avatars/',
656 VIDEO_CAPTIONS: '/static/video-captions/'
658 const STATIC_DOWNLOAD_PATHS = {
659 TORRENTS: '/download/torrents/',
660 VIDEOS: '/download/videos/'
664 let STATIC_MAX_AGE = '2h'
666 // Videos thumbnail size
667 const THUMBNAILS_SIZE = {
671 const PREVIEWS_SIZE = {
675 const AVATARS_SIZE = {
685 // Sub folders of cache directory
686 const FILES_CACHE = {
688 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
689 MAX_AGE: 1000 * 3600 * 3 // 3 hours
692 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
693 MAX_AGE: 1000 * 3600 * 3 // 3 hours
703 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
704 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
706 const MEMOIZE_TTL = {
707 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
716 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
718 // ---------------------------------------------------------------------------
720 const CUSTOM_HTML_TAG_COMMENTS = {
721 TITLE: '<!-- title tag -->',
722 DESCRIPTION: '<!-- description tag -->',
723 CUSTOM_CSS: '<!-- custom css tag -->',
724 META_TAGS: '<!-- meta tags -->'
727 // ---------------------------------------------------------------------------
733 // ---------------------------------------------------------------------------
735 const TRACKER_RATE_LIMITS = {
736 INTERVAL: 60000 * 5, // 5 minutes
737 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
738 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
741 const P2P_MEDIA_LOADER_PEER_VERSION = 2
743 // ---------------------------------------------------------------------------
745 // Special constants for a test instance
746 if (isTestInstance() === true) {
747 PRIVATE_RSA_KEY_SIZE = 1024
749 ACTOR_FOLLOW_SCORE.BASE = 20
751 REMOTE_SCHEME.HTTP = 'http'
752 REMOTE_SCHEME.WS = 'ws'
756 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
757 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
758 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
759 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
761 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
763 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
764 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
765 SCHEDULER_INTERVALS_MS.updateVideos = 5000
766 REPEAT_JOBS['videos-views'] = { every: 5000 }
768 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
770 VIDEO_VIEW_LIFETIME = 1000 // 1 second
771 CONTACT_FORM_LIFETIME = 1000 // 1 second
773 JOB_ATTEMPTS['email'] = 1
775 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
776 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
777 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
779 RATES_LIMIT.LOGIN.MAX = 20
782 updateWebserverUrls()
784 // ---------------------------------------------------------------------------
788 HLS_REDUNDANCY_DIRECTORY,
789 P2P_MEDIA_LOADER_PEER_VERSION,
801 LAST_MIGRATION_VERSION,
803 CUSTOM_HTML_TAG_COMMENTS,
804 BROADCAST_CONCURRENCY,
811 PRIVATE_RSA_KEY_SIZE,
812 ROUTE_CACHE_LIFETIME,
814 HLS_STREAMING_PLAYLIST_DIRECTORY,
820 VIDEO_IMPORT_TIMEOUT,
821 VIDEO_PLAYLIST_TYPES,
823 ACTIVITY_PUB_ACTOR_TYPES,
831 VIDEO_TRANSCODING_FPS,
836 USER_PASSWORD_RESET_LIFETIME,
838 USER_EMAIL_VERIFY_LIFETIME,
840 SCHEDULER_INTERVALS_MS,
842 STATIC_DOWNLOAD_PATHS,
845 CRAWL_REQUEST_CONCURRENCY,
846 JOB_COMPLETED_LIFETIME,
850 CONTACT_FORM_LIFETIME,
851 VIDEO_PLAYLIST_PRIVACIES,
855 // ---------------------------------------------------------------------------
857 function getLocalConfigFilePath () {
858 const configSources = config.util.getConfigSources()
859 if (configSources.length === 0) throw new Error('Invalid config source.')
861 let filename = 'local'
862 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
863 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
865 return join(dirname(configSources[ 0 ].name), filename + '.json')
868 function buildVideoMimetypeExt () {
870 'video/webm': '.webm',
875 if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
876 Object.assign(data, {
877 'video/quicktime': '.mov',
878 'video/x-msvideo': '.avi',
879 'video/x-flv': '.flv',
880 'video/x-matroska': '.mkv',
881 'application/octet-stream': '.mkv',
889 function updateWebserverUrls () {
890 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
891 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
894 function updateWebserverConfig () {
895 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
897 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
898 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
901 function buildVideosExtname () {
902 return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
903 ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
904 : [ '.mp4', '.ogv', '.webm' ]
907 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
910 if (!Array.isArray(objs)) return objs
912 return objs.map(obj => {
913 return Object.assign({}, obj, {
914 minLifetime: parseDuration(obj.min_lifetime),
915 size: bytes.parse(obj.size),
916 minViews: obj.min_views
921 function buildLanguages () {
922 const iso639 = require('iso-639-3')
924 const languages: { [ id: string ]: string } = {}
926 const additionalLanguages = {
927 'sgn': true, // Sign languages (macro language)
928 'ase': true, // American sign language
929 'sdl': true, // Arabian sign language
930 'bfi': true, // British sign language
931 'bzs': true, // Brazilian sign language
932 'csl': true, // Chinese sign language
933 'cse': true, // Czech sign language
934 'dsl': true, // Danish sign language
935 'fsl': true, // French sign language
936 'gsg': true, // German sign language
937 'pks': true, // Pakistan sign language
938 'jsl': true, // Japanese sign language
939 'sfs': true, // South African sign language
940 'swl': true, // Swedish sign language
941 'rsl': true, // Russian sign language: true
943 'epo': true, // Esperanto
944 'tlh': true, // Klingon
945 'jbo': true, // Lojban
946 'avk': true // Kotava
949 // Only add ISO639-1 languages and some sign languages (ISO639-3)
952 return (l.iso6391 !== null && l.type === 'living') ||
953 additionalLanguages[l.iso6393] === true
955 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
957 // Override Occitan label
958 languages['oc'] = 'Occitan'
963 export function reloadConfig () {
965 function directory () {
966 if (process.env.NODE_CONFIG_DIR) {
967 return process.env.NODE_CONFIG_DIR
970 return join(root(), 'config')
974 for (const fileName in require.cache) {
975 if (-1 === fileName.indexOf(directory())) {
979 delete require.cache[fileName]
982 delete require.cache[require.resolve('config')]
987 config = require('config')
989 updateWebserverConfig()
990 updateWebserverUrls()