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