]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
advertising PeerTube's rather simple DNT policy
[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'
3fd3ab2d 6import { VideoPrivacy } 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
7a93e281 18const LAST_MIGRATION_VERSION = 240
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' ],
9c2c18f3 37 VIDEO_ABUSES: [ 'id', 'createdAt' ],
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') }
214 }
215 }
216 },
f981dae8
C
217 CACHE: {
218 PREVIEWS: {
fd206f0b 219 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
220 },
221 VIDEO_CAPTIONS: {
222 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 223 }
66b16caf
C
224 },
225 INSTANCE: {
226 get NAME () { return config.get<string>('instance.name') },
2e3a0215 227 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 228 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 229 get TERMS () { return config.get<string>('instance.terms') },
901637bb 230 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 231 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
232 CUSTOMIZATIONS: {
233 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
234 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37
RK
235 },
236 get ROBOTS () { return config.get<string>('instance.robots') }
8be1afa1
C
237 },
238 SERVICES: {
239 TWITTER: {
240 get USERNAME () { return config.get<string>('services.twitter.username') },
241 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
242 }
e861452f
C
243 }
244}
e861452f 245
9f6bae3a
C
246// ---------------------------------------------------------------------------
247
e4c55619
C
248const CONSTRAINTS_FIELDS = {
249 USERS: {
ed56ad11
C
250 NAME: { min: 3, max: 120 }, // Length
251 DESCRIPTION: { min: 3, max: 250 }, // Length
e4c55619 252 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e
C
253 PASSWORD: { min: 6, max: 255 }, // Length
254 VIDEO_QUOTA: { min: -1 }
e4c55619 255 },
55fa55a9
C
256 VIDEO_ABUSES: {
257 REASON: { min: 2, max: 300 } // Length
258 },
72c7248b 259 VIDEO_CHANNELS: {
a265f7f3 260 NAME: { min: 3, max: 120 }, // Length
a10fc78b
C
261 DESCRIPTION: { min: 3, max: 500 }, // Length
262 SUPPORT: { min: 3, max: 500 }, // Length
e34c85e5 263 URL: { min: 3, max: 2000 } // Length
72c7248b 264 },
40e87e9e
C
265 VIDEO_CAPTIONS: {
266 CAPTION_FILE: {
f4001cf4 267 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
268 FILE_SIZE: {
269 max: 2 * 1024 * 1024 // 2MB
270 }
271 }
272 },
fbad87b0
C
273 VIDEO_IMPORTS: {
274 URL: { min: 3, max: 2000 } // Length
275 },
e4c55619 276 VIDEOS: {
a265f7f3 277 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 278 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 279 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 280 DESCRIPTION: { min: 3, max: 10000 }, // Length
a10fc78b 281 SUPPORT: { min: 3, max: 500 }, // Length
ac81d1a0
C
282 IMAGE: {
283 EXTNAME: [ '.jpg', '.jpeg' ],
284 FILE_SIZE: {
285 max: 2 * 1024 * 1024 // 2MB
286 }
287 },
feb4bdfd 288 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 289 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 290 DURATION: { min: 0 }, // Number
a265f7f3
C
291 TAGS: { min: 0, max: 5 }, // Number of total tags
292 TAG: { min: 2, max: 30 }, // Length
e4c55619 293 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
294 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
295 VIEWS: { min: 0 },
296 LIKES: { min: 0 },
93e1258c 297 DISLIKES: { min: 0 },
c60774b0 298 FILE_SIZE: { min: 10 },
e34c85e5
C
299 URL: { min: 3, max: 2000 } // Length
300 },
01de67b9 301 ACTORS: {
e34c85e5
C
302 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
303 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
304 URL: { min: 3, max: 2000 }, // Length
305 AVATAR: {
01de67b9
C
306 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
307 FILE_SIZE: {
308 max: 2 * 1024 * 1024 // 2MB
309 }
c5911fd3 310 }
e4c87ec2
C
311 },
312 VIDEO_EVENTS: {
313 COUNT: { min: 0 }
6d852470 314 },
bf1f6508 315 VIDEO_COMMENTS: {
b32b7827 316 TEXT: { min: 1, max: 3000 }, // Length
6d852470 317 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
318 },
319 VIDEO_SHARE: {
320 URL: { min: 3, max: 2000 } // Length
e4c55619
C
321 }
322}
323
490b595a
C
324const RATES_LIMIT = {
325 LOGIN: {
326 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 327 MAX: 15 // 15 attempts
490b595a
C
328 }
329}
330
b5c0e955 331let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a7977280
C
332const VIDEO_TRANSCODING_FPS = {
333 MIN: 10,
3a6f351b
C
334 AVERAGE: 30,
335 MAX: 60,
336 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 337}
b5c0e955 338
ee9e7b61 339const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
340 LIKE: 'like',
341 DISLIKE: 'dislike'
342}
343
80bc88c1
J
344const FFMPEG_NICE: { [ id: string ]: number } = {
345 THUMBNAIL: 2, // 2 just for don't blocking servers
346 TRANSCODING: 15
347}
348
6e07c3de
C
349const VIDEO_CATEGORIES = {
350 1: 'Music',
351 2: 'Films',
352 3: 'Vehicles',
353 4: 'Art',
354 5: 'Sports',
355 6: 'Travels',
356 7: 'Gaming',
357 8: 'People',
358 9: 'Comedy',
359 10: 'Entertainment',
360 11: 'News',
40298b02 361 12: 'How To',
6e07c3de
C
362 13: 'Education',
363 14: 'Activism',
364 15: 'Science & Technology',
365 16: 'Animals',
366 17: 'Kids',
367 18: 'Food'
368}
369
6f0c39e2
C
370// See https://creativecommons.org/licenses/?lang=en
371const VIDEO_LICENCES = {
372 1: 'Attribution',
373 2: 'Attribution - Share Alike',
374 3: 'Attribution - No Derivatives',
375 4: 'Attribution - Non Commercial',
376 5: 'Attribution - Non Commercial - Share Alike',
377 6: 'Attribution - Non Commercial - No Derivatives',
378 7: 'Public Domain Dedication'
379}
380
9d3ef9fe 381const VIDEO_LANGUAGES = buildLanguages()
3092476e 382
fd45e8f4
C
383const VIDEO_PRIVACIES = {
384 [VideoPrivacy.PUBLIC]: 'Public',
385 [VideoPrivacy.UNLISTED]: 'Unlisted',
386 [VideoPrivacy.PRIVATE]: 'Private'
387}
388
2186386c
C
389const VIDEO_STATES = {
390 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
391 [VideoState.TO_TRANSCODE]: 'To transcode',
392 [VideoState.TO_IMPORT]: 'To import'
393}
394
395const VIDEO_IMPORT_STATES = {
396 [VideoImportState.FAILED]: 'Failed',
397 [VideoImportState.PENDING]: 'Pending',
398 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
399}
400
0d0e8dd0 401const VIDEO_MIMETYPE_EXT = {
efc32059
C
402 'video/webm': '.webm',
403 'video/ogg': '.ogv',
404 'video/mp4': '.mp4'
0d0e8dd0 405}
28be8916 406const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 407
ac81d1a0 408const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
409 'image/png': '.png',
410 'image/jpg': '.jpg',
411 'image/jpeg': '.jpg'
412}
413
40e87e9e 414const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
415 'text/vtt': '.vtt',
416 'application/x-subrip': '.srt'
40e87e9e
C
417}
418
9f6bae3a
C
419// ---------------------------------------------------------------------------
420
50d6de9c 421const SERVER_ACTOR_NAME = 'peertube'
350e31d6 422
e4f97bab 423const ACTIVITY_PUB = {
1b5b10d1
C
424 POTENTIAL_ACCEPT_HEADERS: [
425 'application/activity+json',
9a8cbd82
C
426 'application/ld+json',
427 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 428 ],
1b5b10d1 429 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 430 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 431 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 432 FETCH_PAGE_LIMIT: 100,
20494f12 433 URL_MIME_TYPES: {
f05a1c30 434 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
435 TORRENT: [ 'application/x-bittorrent' ],
436 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 437 },
2ccaeeb3 438 MAX_RECURSION_COMMENTS: 100,
7bc29171 439 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
440}
441
50d6de9c
C
442const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
443 GROUP: 'Group',
444 PERSON: 'Person',
445 APPLICATION: 'Application'
446}
447
9f6bae3a
C
448// ---------------------------------------------------------------------------
449
e4f97bab 450const PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 451
9f6bae3a
C
452// Password encryption
453const BCRYPT_SALT_SIZE = 10
a877d5ac 454
ecb4e35f
C
455const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
456
0883b324
C
457const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
458 DO_NOT_LIST: 'do_not_list',
459 BLUR: 'blur',
460 DISPLAY: 'display'
461}
462
bdfbd4f1
C
463// ---------------------------------------------------------------------------
464
052937db
C
465// Express static paths (router)
466const STATIC_PATHS = {
f285faa0
C
467 PREVIEWS: '/static/previews/',
468 THUMBNAILS: '/static/thumbnails/',
052937db 469 TORRENTS: '/static/torrents/',
c5911fd3 470 WEBSEED: '/static/webseed/',
40e87e9e
C
471 AVATARS: '/static/avatars/',
472 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 473}
02756fbd
C
474const STATIC_DOWNLOAD_PATHS = {
475 TORRENTS: '/download/torrents/',
476 VIDEOS: '/download/videos/'
477}
052937db 478
dc009132 479// Cache control
57a81ff6 480let STATIC_MAX_AGE = '2h'
dc009132 481
cbe2f7c3 482// Videos thumbnail size
d8755eed
C
483const THUMBNAILS_SIZE = {
484 width: 200,
485 height: 110
486}
487const PREVIEWS_SIZE = {
164174a6
C
488 width: 560,
489 height: 315
490}
e8e12200
C
491const AVATARS_SIZE = {
492 width: 120,
493 height: 120
494}
164174a6
C
495
496const EMBED_SIZE = {
497 width: 560,
498 height: 315
d8755eed 499}
cbe2f7c3 500
980246ea 501// Sub folders of cache directory
f981dae8 502const CACHE = {
f4001cf4
C
503 PREVIEWS: {
504 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
505 MAX_AGE: 1000 * 3600 * 3 // 3 hours
506 },
507 VIDEO_CAPTIONS: {
508 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
509 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
510 }
511}
512
e12a0092 513const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 514
bdfbd4f1
C
515// ---------------------------------------------------------------------------
516
e032aec9
C
517const CUSTOM_HTML_TAG_COMMENTS = {
518 TITLE: '<!-- title tag -->',
519 DESCRIPTION: '<!-- description tag -->',
520 CUSTOM_CSS: '<!-- custom css tag -->',
521 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
522}
709756b8
C
523
524// ---------------------------------------------------------------------------
525
4195cd2b 526const FEEDS = {
fd4484f1 527 COUNT: 20
4195cd2b
C
528}
529
530// ---------------------------------------------------------------------------
531
9b67da3d
C
532const TRACKER_RATE_LIMITS = {
533 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 534 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
535 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
536}
537
538// ---------------------------------------------------------------------------
539
9f10b292
C
540// Special constants for a test instance
541if (isTestInstance() === true) {
60650c77 542 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 543
f285faa0
C
544 REMOTE_SCHEME.HTTP = 'http'
545 REMOTE_SCHEME.WS = 'ws'
3cd0734f 546
65fcc311 547 STATIC_MAX_AGE = '0'
3cd0734f 548
c46edbc2 549 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 550 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 551
01de67b9 552 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 553
2baea0c7
C
554 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
555 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
556 SCHEDULER_INTERVALS_MS.updateVideos = 5000
557
b5c0e955 558 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
559
560 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
561
562 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
9f10b292
C
563}
564
fd206f0b 565updateWebserverConfig()
225a89c2 566
9f10b292
C
567// ---------------------------------------------------------------------------
568
65fcc311 569export {
9f6bae3a 570 API_VERSION,
40e87e9e 571 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 572 AVATARS_SIZE,
4f491371 573 ACCEPT_HEADERS,
9f6bae3a 574 BCRYPT_SALT_SIZE,
9b67da3d 575 TRACKER_RATE_LIMITS,
f981dae8 576 CACHE,
9f6bae3a
C
577 CONFIG,
578 CONSTRAINTS_FIELDS,
164174a6 579 EMBED_SIZE,
94a5ff8a
C
580 JOB_CONCURRENCY,
581 JOB_ATTEMPTS,
b769007f 582 LAST_MIGRATION_VERSION,
9f6bae3a 583 OAUTH_LIFETIME,
e032aec9 584 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 585 BROADCAST_CONCURRENCY,
1194e8b4 586 PAGINATION,
60650c77 587 ACTOR_FOLLOW_SCORE,
f285faa0
C
588 PREVIEWS_SIZE,
589 REMOTE_SCHEME,
7a7724e6 590 FOLLOW_STATES,
50d6de9c 591 SERVER_ACTOR_NAME,
e4f97bab 592 PRIVATE_RSA_KEY_SIZE,
fd4484f1 593 ROUTE_CACHE_LIFETIME,
9f6bae3a 594 SORTABLE_COLUMNS,
4195cd2b 595 FEEDS,
2b86fe72 596 JOB_TTL,
0883b324 597 NSFW_POLICY_TYPES,
dc009132 598 STATIC_MAX_AGE,
a6375e69 599 STATIC_PATHS,
e4f97bab 600 ACTIVITY_PUB,
50d6de9c 601 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 602 THUMBNAILS_SIZE,
6e07c3de 603 VIDEO_CATEGORIES,
3092476e 604 VIDEO_LANGUAGES,
fd45e8f4 605 VIDEO_PRIVACIES,
6f0c39e2 606 VIDEO_LICENCES,
2186386c 607 VIDEO_STATES,
0d0e8dd0 608 VIDEO_RATE_TYPES,
c5911fd3 609 VIDEO_MIMETYPE_EXT,
a7977280 610 VIDEO_TRANSCODING_FPS,
80bc88c1 611 FFMPEG_NICE,
71e3dfda 612 JOB_REQUEST_TIMEOUT,
ecb4e35f 613 USER_PASSWORD_RESET_LIFETIME,
ac81d1a0 614 IMAGE_MIMETYPE_EXT,
2baea0c7 615 SCHEDULER_INTERVALS_MS,
02756fbd 616 STATIC_DOWNLOAD_PATHS,
490b595a 617 RATES_LIMIT,
28be8916 618 VIDEO_EXT_MIMETYPE,
b5c0e955 619 JOB_COMPLETED_LIFETIME,
fbad87b0 620 VIDEO_IMPORT_STATES,
7ce44a74
C
621 VIDEO_VIEW_LIFETIME,
622 buildLanguages
9f10b292 623}
fd206f0b
C
624
625// ---------------------------------------------------------------------------
626
627function getLocalConfigFilePath () {
628 const configSources = config.util.getConfigSources()
629 if (configSources.length === 0) throw new Error('Invalid config source.')
630
631 let filename = 'local'
632 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
633 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
634
635 return join(dirname(configSources[ 0 ].name), filename + '.json')
636}
637
638function updateWebserverConfig () {
639 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
640 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
641}
642
9d3ef9fe
C
643function buildLanguages () {
644 const iso639 = require('iso-639-3')
645
646 const languages: { [ id: string ]: string } = {}
647
1d94c154
C
648 const additionalLanguages = {
649 'sgn': true, // Sign languages (macro language)
650 'ase': true, // American sign language
651 'sdl': true, // Arabian sign language
652 'bfi': true, // British sign language
653 'bzs': true, // Brazilian sign language
654 'csl': true, // Chinese sign language
655 'cse': true, // Czech sign language
656 'dsl': true, // Danish sign language
657 'fsl': true, // French sign language
658 'gsg': true, // German sign language
659 'pks': true, // Pakistan sign language
660 'jsl': true, // Japanese sign language
661 'sfs': true, // South African sign language
662 'swl': true, // Swedish sign language
663 'rsl': true, // Russian sign language: true
664
665 'epo': true, // Esperanto
666 'tlh': true, // Klingon
667 'jbo': true, // Lojban
668 'avk': true // Kotava
669 }
9d3ef9fe
C
670
671 // Only add ISO639-1 languages and some sign languages (ISO639-3)
672 iso639
673 .filter(l => {
674 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 675 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
676 })
677 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
678
679 return languages
680}
681
fd206f0b
C
682export function reloadConfig () {
683
684 function directory () {
685 if (process.env.NODE_CONFIG_DIR) {
686 return process.env.NODE_CONFIG_DIR
687 }
688
689 return join(root(), 'config')
690 }
691
692 function purge () {
693 for (const fileName in require.cache) {
694 if (-1 === fileName.indexOf(directory())) {
695 continue
696 }
697
698 delete require.cache[fileName]
699 }
700
701 delete require.cache[require.resolve('config')]
702 }
703
704 purge()
705
706 config = require('config')
707
708 updateWebserverConfig()
709}