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