settings.defaults.js 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118
  1. const Path = require('node:path')
  2. const { merge } = require('@overleaf/settings/merge')
  3. let defaultFeatures, siteUrl
  4. // Make time interval config easier.
  5. const seconds = 1000
  6. const minutes = 60 * seconds
  7. // These credentials are used for authenticating api requests
  8. // between services that may need to go over public channels
  9. const httpAuthUser = process.env.WEB_API_USER
  10. const httpAuthPass = process.env.WEB_API_PASSWORD
  11. const httpAuthUsers = {}
  12. if (httpAuthUser && httpAuthPass) {
  13. httpAuthUsers[httpAuthUser] = httpAuthPass
  14. }
  15. const intFromEnv = function (name, defaultValue) {
  16. if (
  17. [null, undefined].includes(defaultValue) ||
  18. typeof defaultValue !== 'number'
  19. ) {
  20. throw new Error(
  21. `Bad default integer value for setting: ${name}, ${defaultValue}`
  22. )
  23. }
  24. return parseInt(process.env[name], 10) || defaultValue
  25. }
  26. const defaultTextExtensions = [
  27. 'tex',
  28. 'latex',
  29. 'sty',
  30. 'cls',
  31. 'bst',
  32. 'bib',
  33. 'bibtex',
  34. 'txt',
  35. 'tikz',
  36. 'mtx',
  37. 'rtex',
  38. 'md',
  39. 'asy',
  40. 'lbx',
  41. 'bbx',
  42. 'cbx',
  43. 'm',
  44. 'lco',
  45. 'dtx',
  46. 'ins',
  47. 'ist',
  48. 'def',
  49. 'clo',
  50. 'ldf',
  51. 'rmd',
  52. 'lua',
  53. 'py',
  54. 'gv',
  55. 'mf',
  56. 'yml',
  57. 'yaml',
  58. 'lhs',
  59. 'lean',
  60. 'lean4',
  61. 'hs',
  62. 'mk',
  63. 'xmpdata',
  64. 'cfg',
  65. 'rnw',
  66. 'ltx',
  67. 'inc',
  68. ]
  69. const parseTextExtensions = function (extensions) {
  70. if (extensions) {
  71. return extensions.split(',').map(ext => ext.trim())
  72. } else {
  73. return []
  74. }
  75. }
  76. const httpPermissionsPolicy = {
  77. blocked: [
  78. 'accelerometer',
  79. 'attribution-reporting',
  80. 'browsing-topics',
  81. 'camera',
  82. 'display-capture',
  83. 'encrypted-media',
  84. 'gamepad',
  85. 'geolocation',
  86. 'gyroscope',
  87. 'hid',
  88. 'identity-credentials-get',
  89. 'idle-detection',
  90. 'local-fonts',
  91. 'magnetometer',
  92. 'midi',
  93. 'otp-credentials',
  94. 'payment',
  95. 'picture-in-picture',
  96. 'screen-wake-lock',
  97. 'serial',
  98. 'storage-access',
  99. 'usb',
  100. 'window-management',
  101. 'xr-spatial-tracking',
  102. ],
  103. allowed: {
  104. autoplay: 'self "https://videos.ctfassets.net"',
  105. fullscreen: 'self',
  106. 'on-device-speech-recognition': 'self',
  107. },
  108. }
  109. module.exports = {
  110. env: 'server-ce',
  111. limits: {
  112. httpGlobalAgentMaxSockets: 300,
  113. httpsGlobalAgentMaxSockets: 300,
  114. },
  115. allowAnonymousReadAndWriteSharing:
  116. process.env.OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING === 'true',
  117. // Databases
  118. // ---------
  119. mongo: {
  120. options: {
  121. appname: 'web',
  122. maxPoolSize: parseInt(process.env.MONGO_POOL_SIZE, 10) || 100,
  123. serverSelectionTimeoutMS:
  124. parseInt(process.env.MONGO_SERVER_SELECTION_TIMEOUT, 10) || 60000,
  125. // Setting socketTimeoutMS to 0 means no timeout
  126. socketTimeoutMS: parseInt(
  127. process.env.MONGO_SOCKET_TIMEOUT ?? '60000',
  128. 10
  129. ),
  130. monitorCommands: true,
  131. },
  132. url:
  133. process.env.MONGO_CONNECTION_STRING ||
  134. process.env.MONGO_URL ||
  135. `mongodb://${process.env.MONGO_HOST || '127.0.0.1'}/sharelatex`,
  136. hasSecondaries: process.env.MONGO_HAS_SECONDARIES === 'true',
  137. },
  138. redis: {
  139. web: {
  140. host: process.env.REDIS_HOST || '127.0.0.1',
  141. port: process.env.REDIS_PORT || '6379',
  142. password: process.env.REDIS_PASSWORD || '',
  143. db: process.env.REDIS_DB,
  144. maxRetriesPerRequest: parseInt(
  145. process.env.REDIS_MAX_RETRIES_PER_REQUEST || '20'
  146. ),
  147. },
  148. // websessions:
  149. // cluster: [
  150. // {host: '127.0.0.1', port: 7000}
  151. // {host: '127.0.0.1', port: 7001}
  152. // {host: '127.0.0.1', port: 7002}
  153. // {host: '127.0.0.1', port: 7003}
  154. // {host: '127.0.0.1', port: 7004}
  155. // {host: '127.0.0.1', port: 7005}
  156. // ]
  157. // ratelimiter:
  158. // cluster: [
  159. // {host: '127.0.0.1', port: 7000}
  160. // {host: '127.0.0.1', port: 7001}
  161. // {host: '127.0.0.1', port: 7002}
  162. // {host: '127.0.0.1', port: 7003}
  163. // {host: '127.0.0.1', port: 7004}
  164. // {host: '127.0.0.1', port: 7005}
  165. // ]
  166. // cooldown:
  167. // cluster: [
  168. // {host: '127.0.0.1', port: 7000}
  169. // {host: '127.0.0.1', port: 7001}
  170. // {host: '127.0.0.1', port: 7002}
  171. // {host: '127.0.0.1', port: 7003}
  172. // {host: '127.0.0.1', port: 7004}
  173. // {host: '127.0.0.1', port: 7005}
  174. // ]
  175. api: {
  176. host: process.env.REDIS_HOST || '127.0.0.1',
  177. port: process.env.REDIS_PORT || '6379',
  178. password: process.env.REDIS_PASSWORD || '',
  179. maxRetriesPerRequest: parseInt(
  180. process.env.REDIS_MAX_RETRIES_PER_REQUEST || '20'
  181. ),
  182. },
  183. },
  184. // Service locations
  185. // -----------------
  186. // Configure which ports to run each service on. Generally you
  187. // can leave these as they are unless you have some other services
  188. // running which conflict, or want to run the web process on port 80.
  189. internal: {
  190. web: {
  191. port: process.env.WEB_PORT || 3000,
  192. host: process.env.LISTEN_ADDRESS || '127.0.0.1',
  193. },
  194. },
  195. // Tell each service where to find the other services. If everything
  196. // is running locally then this is easy, but they exist as separate config
  197. // options incase you want to run some services on remote hosts.
  198. apis: {
  199. web: {
  200. url: `http://${
  201. process.env.WEB_API_HOST || process.env.WEB_HOST || '127.0.0.1'
  202. }:${process.env.WEB_API_PORT || process.env.WEB_PORT || 3000}`,
  203. user: httpAuthUser,
  204. pass: httpAuthPass,
  205. },
  206. documentupdater: {
  207. url: `http://${
  208. process.env.DOCUPDATER_HOST ||
  209. process.env.DOCUMENT_UPDATER_HOST ||
  210. '127.0.0.1'
  211. }:3003`,
  212. },
  213. docstore: {
  214. url: `http://${process.env.DOCSTORE_HOST || '127.0.0.1'}:3016`,
  215. pubUrl: `http://${process.env.DOCSTORE_HOST || '127.0.0.1'}:3016`,
  216. },
  217. chat: {
  218. internal_url: `http://${process.env.CHAT_HOST || '127.0.0.1'}:3010`,
  219. },
  220. filestore: {
  221. url: `http://${process.env.FILESTORE_HOST || '127.0.0.1'}:3009`,
  222. },
  223. clsi: {
  224. url: `http://${process.env.CLSI_HOST || '127.0.0.1'}:3013`,
  225. downloadHost: process.env.CLSI_LB_IP
  226. ? `http://${process.env.CLSI_LB_IP}:80`
  227. : `http://${process.env.DOWNLOAD_HOST || '127.0.0.1'}:8080`,
  228. backendGroupName: undefined,
  229. submissionBackendClass:
  230. process.env.CLSI_SUBMISSION_BACKEND_CLASS || 'c3d',
  231. },
  232. clsiCache: {
  233. instances: JSON.parse(process.env.CLSI_CACHE_INSTANCES || '[]'),
  234. },
  235. project_history: {
  236. sendProjectStructureOps: true,
  237. url: `http://${process.env.PROJECT_HISTORY_HOST || '127.0.0.1'}:3054`,
  238. },
  239. historyBackupDeletion: {
  240. enabled: false,
  241. url: `http://${process.env.HISTORY_BACKUP_DELETION_HOST || '127.0.0.1'}:3101`,
  242. user: process.env.HISTORY_BACKUP_DELETION_USER || 'staging',
  243. pass: process.env.HISTORY_BACKUP_DELETION_PASS,
  244. },
  245. realTime: {
  246. url: `http://${process.env.REALTIME_HOST || '127.0.0.1'}:3026`,
  247. },
  248. contacts: {
  249. url: `http://${process.env.CONTACTS_HOST || '127.0.0.1'}:3036`,
  250. },
  251. notifications: {
  252. url: `http://${process.env.NOTIFICATIONS_HOST || '127.0.0.1'}:3042`,
  253. },
  254. webpack: {
  255. url: `http://${process.env.WEBPACK_HOST || '127.0.0.1'}:3808`,
  256. },
  257. wiki: {
  258. url: process.env.WIKI_URL || 'https://learnwiki.overleaf.com',
  259. maxCacheAge: parseInt(process.env.WIKI_MAX_CACHE_AGE || 5 * minutes, 10),
  260. },
  261. haveIBeenPwned: {
  262. enabled: process.env.HAVE_I_BEEN_PWNED_ENABLED === 'true',
  263. url:
  264. process.env.HAVE_I_BEEN_PWNED_URL || 'https://api.pwnedpasswords.com',
  265. timeout: parseInt(process.env.HAVE_I_BEEN_PWNED_TIMEOUT, 10) || 5 * 1000,
  266. },
  267. v1_history: {
  268. url:
  269. process.env.V1_HISTORY_URL ||
  270. `http://${process.env.V1_HISTORY_HOST || '127.0.0.1'}:${
  271. process.env.V1_HISTORY_PORT || '3100'
  272. }/api`,
  273. urlForGitBridge: process.env.V1_HISTORY_URL_FOR_GIT_BRIDGE,
  274. user: process.env.V1_HISTORY_USER || 'staging',
  275. pass:
  276. process.env.V1_HISTORY_PASS ||
  277. process.env.V1_HISTORY_PASSWORD ||
  278. 'password',
  279. buckets: {
  280. globalBlobs: process.env.OVERLEAF_EDITOR_BLOBS_BUCKET,
  281. projectBlobs: process.env.OVERLEAF_EDITOR_PROJECT_BLOBS_BUCKET,
  282. },
  283. },
  284. // For legacy reasons, we need to populate the below objects.
  285. v1: {},
  286. recurly: {},
  287. },
  288. // Defines which features are allowed in the
  289. // Permissions-Policy HTTP header
  290. httpPermissions: httpPermissionsPolicy,
  291. useHttpPermissionsPolicy: true,
  292. jwt: {
  293. key: process.env.OT_JWT_AUTH_KEY,
  294. algorithm: process.env.OT_JWT_AUTH_ALG || 'HS256',
  295. },
  296. devToolbar: {
  297. enabled: false,
  298. },
  299. splitTests: [],
  300. // Where your instance of Overleaf Community Edition/Server Pro can be found publicly. Used in emails
  301. // that are sent out, generated links, etc.
  302. siteUrl: (siteUrl = process.env.PUBLIC_URL || 'http://127.0.0.1:3000'),
  303. isCodeSpace: process.env.IS_CODE_SPACE === 'true',
  304. isDevEnv: process.env.NODE_ENV === 'development',
  305. lockManager: {
  306. lockTestInterval: intFromEnv('LOCK_MANAGER_LOCK_TEST_INTERVAL', 50),
  307. maxTestInterval: intFromEnv('LOCK_MANAGER_MAX_TEST_INTERVAL', 1000),
  308. maxLockWaitTime: intFromEnv('LOCK_MANAGER_MAX_LOCK_WAIT_TIME', 10000),
  309. redisLockExpiry: intFromEnv('LOCK_MANAGER_REDIS_LOCK_EXPIRY', 30),
  310. slowExecutionThreshold: intFromEnv(
  311. 'LOCK_MANAGER_SLOW_EXECUTION_THRESHOLD',
  312. 5000
  313. ),
  314. },
  315. // Optional separate location for websocket connections, if unset defaults to siteUrl.
  316. wsUrl: process.env.WEBSOCKET_URL,
  317. wsUrlV2: process.env.WEBSOCKET_URL_V2,
  318. wsUrlBeta: process.env.WEBSOCKET_URL_BETA,
  319. wsUrlV2Percentage: parseInt(
  320. process.env.WEBSOCKET_URL_V2_PERCENTAGE || '0',
  321. 10
  322. ),
  323. wsRetryHandshake: parseInt(process.env.WEBSOCKET_RETRY_HANDSHAKE || '5', 10),
  324. // cookie domain
  325. // use full domain for cookies to only be accessible from that domain,
  326. // replace subdomain with dot to have them accessible on all subdomains
  327. cookieDomain: process.env.COOKIE_DOMAIN,
  328. cookieName: process.env.COOKIE_NAME || 'overleaf.sid',
  329. cookieRollingSession: true,
  330. // this is only used if cookies are used for clsi backend
  331. // clsiCookieKey: "clsiserver"
  332. robotsNoindex: process.env.ROBOTS_NOINDEX === 'true' || false,
  333. maxEntitiesPerProject: parseInt(
  334. process.env.MAX_ENTITIES_PER_PROJECT || '2000',
  335. 10
  336. ),
  337. projectUploadTimeout: parseInt(
  338. process.env.PROJECT_UPLOAD_TIMEOUT || '120000',
  339. 10
  340. ),
  341. maxUploadSize: 50 * 1024 * 1024, // 50 MB
  342. multerOptions: {
  343. preservePath: process.env.MULTER_PRESERVE_PATH,
  344. },
  345. notifyOnSystemMessageChanges:
  346. process.env.NOTIFY_ON_SYSTEM_MESSAGE_CHANGES === 'true',
  347. // start failing the health check if active handles exceeds this limit
  348. maxActiveHandles: process.env.MAX_ACTIVE_HANDLES
  349. ? parseInt(process.env.MAX_ACTIVE_HANDLES, 10)
  350. : undefined,
  351. // Security
  352. // --------
  353. security: {
  354. sessionSecret: process.env.SESSION_SECRET,
  355. sessionSecretUpcoming: process.env.SESSION_SECRET_UPCOMING,
  356. sessionSecretFallback: process.env.SESSION_SECRET_FALLBACK,
  357. bcryptRounds: parseInt(process.env.BCRYPT_ROUNDS, 10) || 12,
  358. }, // number of rounds used to hash user passwords (raised to power 2)
  359. adminUrl: process.env.ADMIN_URL,
  360. adminOnlyLogin: process.env.ADMIN_ONLY_LOGIN === 'true',
  361. adminPrivilegeAvailable: process.env.ADMIN_PRIVILEGE_AVAILABLE === 'true',
  362. adminRolesEnabled: false,
  363. blockCrossOriginRequests: process.env.BLOCK_CROSS_ORIGIN_REQUESTS === 'true',
  364. allowedOrigins: (process.env.ALLOWED_ORIGINS || siteUrl).split(','),
  365. httpAuthUsers,
  366. // Default features
  367. // ----------------
  368. //
  369. // You can select the features that are enabled by default for new
  370. // new users.
  371. defaultFeatures: (defaultFeatures = {
  372. collaborators: -1,
  373. dropbox: true,
  374. github: true,
  375. gitBridge: true,
  376. versioning: true,
  377. compileTimeout: 180,
  378. compileGroup: 'standard',
  379. references: true,
  380. trackChanges: true,
  381. }),
  382. // featuresEpoch: 'YYYY-MM-DD',
  383. features: {
  384. personal: defaultFeatures,
  385. },
  386. aiFeatures: {
  387. freeQuota: 'free',
  388. standardQuota: 'standard',
  389. basicQuota: 'basic',
  390. unlimitedQuota: 'unlimited',
  391. },
  392. quotaGrants: {
  393. ai: {
  394. free: 0,
  395. basic: 0,
  396. standard: 0,
  397. unlimited: 0,
  398. },
  399. },
  400. groupPlanModalOptions: {
  401. plan_codes: [],
  402. currencies: [],
  403. sizes: [],
  404. usages: [],
  405. },
  406. plans: [
  407. {
  408. planCode: 'personal',
  409. name: 'Personal',
  410. price_in_cents: 0,
  411. features: defaultFeatures,
  412. },
  413. ],
  414. disableChat: process.env.OVERLEAF_DISABLE_CHAT === 'true',
  415. disableLinkSharing: process.env.OVERLEAF_DISABLE_LINK_SHARING === 'true',
  416. enableSubscriptions: false,
  417. restrictedCountries: [],
  418. enableOnboardingEmails: process.env.ENABLE_ONBOARDING_EMAILS === 'true',
  419. enabledLinkedFileTypes: (process.env.ENABLED_LINKED_FILE_TYPES || '').split(
  420. ','
  421. ),
  422. // i18n
  423. // ------
  424. //
  425. i18n: {
  426. checkForHTMLInVars: process.env.I18N_CHECK_FOR_HTML_IN_VARS === 'true',
  427. escapeHTMLInVars: process.env.I18N_ESCAPE_HTML_IN_VARS === 'true',
  428. subdomainLang: {
  429. www: { lngCode: 'en', url: siteUrl },
  430. },
  431. defaultLng: 'en',
  432. },
  433. // Spelling languages
  434. // dic = available in client
  435. // server: false = not available on server
  436. // ------------------
  437. languages: [
  438. { code: 'en', name: 'English' },
  439. { code: 'en_US', dic: 'en_US', name: 'English (American)' },
  440. { code: 'en_GB', dic: 'en_GB', name: 'English (British)' },
  441. { code: 'en_CA', dic: 'en_CA', name: 'English (Canadian)' },
  442. {
  443. code: 'en_AU',
  444. dic: 'en_AU',
  445. name: 'English (Australian)',
  446. server: false,
  447. },
  448. {
  449. code: 'en_ZA',
  450. dic: 'en_ZA',
  451. name: 'English (South African)',
  452. server: false,
  453. },
  454. { code: 'af', dic: 'af_ZA', name: 'Afrikaans' },
  455. { code: 'an', dic: 'an_ES', name: 'Aragonese', server: false },
  456. { code: 'ar', dic: 'ar', name: 'Arabic' },
  457. { code: 'be_BY', dic: 'be_BY', name: 'Belarusian', server: false },
  458. { code: 'eu', dic: 'eu', name: 'Basque' },
  459. { code: 'bn_BD', dic: 'bn_BD', name: 'Bengali', server: false },
  460. { code: 'bs_BA', dic: 'bs_BA', name: 'Bosnian', server: false },
  461. { code: 'br', dic: 'br_FR', name: 'Breton' },
  462. { code: 'bg', dic: 'bg_BG', name: 'Bulgarian' },
  463. { code: 'ca', dic: 'ca', name: 'Catalan' },
  464. { code: 'hr', dic: 'hr_HR', name: 'Croatian' },
  465. { code: 'cs', dic: 'cs_CZ', name: 'Czech' },
  466. { code: 'da', dic: 'da_DK', name: 'Danish' },
  467. { code: 'nl', dic: 'nl', name: 'Dutch' },
  468. { code: 'dz', dic: 'dz', name: 'Dzongkha', server: false },
  469. { code: 'eo', dic: 'eo', name: 'Esperanto' },
  470. { code: 'et', dic: 'et_EE', name: 'Estonian' },
  471. { code: 'fo', dic: 'fo', name: 'Faroese' },
  472. { code: 'fr', dic: 'fr', name: 'French' },
  473. { code: 'gl', dic: 'gl_ES', name: 'Galician' },
  474. { code: 'de', dic: 'de_DE', name: 'German' },
  475. { code: 'de_AT', dic: 'de_AT', name: 'German (Austria)', server: false },
  476. {
  477. code: 'de_CH',
  478. dic: 'de_CH',
  479. name: 'German (Switzerland)',
  480. server: false,
  481. },
  482. { code: 'el', dic: 'el_GR', name: 'Greek' },
  483. { code: 'gug_PY', dic: 'gug_PY', name: 'Guarani', server: false },
  484. { code: 'gu_IN', dic: 'gu_IN', name: 'Gujarati', server: false },
  485. { code: 'he_IL', dic: 'he_IL', name: 'Hebrew', server: false },
  486. { code: 'hi_IN', dic: 'hi_IN', name: 'Hindi', server: false },
  487. { code: 'hu_HU', dic: 'hu_HU', name: 'Hungarian', server: false },
  488. { code: 'is_IS', dic: 'is_IS', name: 'Icelandic', server: false },
  489. { code: 'id', dic: 'id_ID', name: 'Indonesian' },
  490. { code: 'ga', dic: 'ga_IE', name: 'Irish' },
  491. { code: 'it', dic: 'it_IT', name: 'Italian' },
  492. { code: 'kk', dic: 'kk_KZ', name: 'Kazakh' },
  493. { code: 'ko', dic: 'ko', name: 'Korean', server: false },
  494. { code: 'ku', name: 'Kurdish' },
  495. { code: 'kmr', dic: 'kmr_Latn', name: 'Kurmanji', server: false },
  496. { code: 'lv', dic: 'lv_LV', name: 'Latvian' },
  497. { code: 'lt', dic: 'lt_LT', name: 'Lithuanian' },
  498. { code: 'lo_LA', dic: 'lo_LA', name: 'Laotian', server: false },
  499. { code: 'ml_IN', dic: 'ml_IN', name: 'Malayalam', server: false },
  500. { code: 'mn_MN', dic: 'mn_MN', name: 'Mongolian', server: false },
  501. { code: 'nr', name: 'Ndebele' },
  502. { code: 'ne_NP', dic: 'ne_NP', name: 'Nepali', server: false },
  503. { code: 'ns', name: 'Northern Sotho' },
  504. { code: 'no', name: 'Norwegian' },
  505. { code: 'nb_NO', dic: 'nb_NO', name: 'Norwegian (Bokmål)', server: false },
  506. { code: 'nn_NO', dic: 'nn_NO', name: 'Norwegian (Nynorsk)', server: false },
  507. { code: 'oc_FR', dic: 'oc_FR', name: 'Occitan', server: false },
  508. { code: 'fa', dic: 'fa_IR', name: 'Persian' },
  509. { code: 'pl', dic: 'pl_PL', name: 'Polish' },
  510. { code: 'pt_BR', dic: 'pt_BR', name: 'Portuguese (Brazilian)' },
  511. {
  512. code: 'pt_PT',
  513. dic: 'pt_PT',
  514. name: 'Portuguese (European)',
  515. },
  516. { code: 'pa', name: 'Punjabi' },
  517. { code: 'ro', dic: 'ro_RO', name: 'Romanian' },
  518. { code: 'ru', dic: 'ru_RU', name: 'Russian' },
  519. { code: 'gd_GB', dic: 'gd_GB', name: 'Scottish Gaelic', server: false },
  520. { code: 'sr_RS', dic: 'sr_RS', name: 'Serbian', server: false },
  521. { code: 'si_LK', dic: 'si_LK', name: 'Sinhala', server: false },
  522. { code: 'sk', dic: 'sk_SK', name: 'Slovak' },
  523. { code: 'sl', dic: 'sl_SI', name: 'Slovenian' },
  524. { code: 'st', name: 'Southern Sotho' },
  525. { code: 'es', dic: 'es_ES', name: 'Spanish' },
  526. { code: 'sw_TZ', dic: 'sw_TZ', name: 'Swahili', server: false },
  527. { code: 'sv', dic: 'sv_SE', name: 'Swedish' },
  528. { code: 'tl', dic: 'tl', name: 'Tagalog' },
  529. { code: 'te_IN', dic: 'te_IN', name: 'Telugu', server: false },
  530. { code: 'th_TH', dic: 'th_TH', name: 'Thai', server: false },
  531. { code: 'bo', dic: 'bo', name: 'Tibetan', server: false },
  532. { code: 'ts', name: 'Tsonga' },
  533. { code: 'tn', name: 'Tswana' },
  534. { code: 'tr_TR', dic: 'tr_TR', name: 'Turkish', server: false },
  535. { code: 'uk_UA', dic: 'uk_UA', name: 'Ukrainian', server: false },
  536. { code: 'hsb', name: 'Upper Sorbian' },
  537. { code: 'uz_UZ', dic: 'uz_UZ', name: 'Uzbek', server: false },
  538. { code: 'vi_VN', dic: 'vi_VN', name: 'Vietnamese', server: false },
  539. { code: 'cy', name: 'Welsh' },
  540. { code: 'xh', name: 'Xhosa' },
  541. ],
  542. translatedLanguages: {
  543. cn: '简体中文',
  544. cs: 'Čeština',
  545. da: 'Dansk',
  546. de: 'Deutsch',
  547. en: 'English',
  548. es: 'Español',
  549. fi: 'Suomi',
  550. fr: 'Français',
  551. it: 'Italiano',
  552. ja: '日本語',
  553. ko: '한국어',
  554. nl: 'Nederlands',
  555. no: 'Norsk',
  556. pl: 'Polski',
  557. pt: 'Português',
  558. ro: 'Română',
  559. ru: 'Русский',
  560. sv: 'Svenska',
  561. tr: 'Türkçe',
  562. uk: 'Українська',
  563. 'zh-CN': '简体中文',
  564. },
  565. maxDictionarySize: 1024 * 1024, // 1 MB
  566. // Password Settings
  567. // -----------
  568. // These restrict the passwords users can use when registering
  569. // opts are from http://antelle.github.io/passfield
  570. passwordStrengthOptions: {
  571. length: {
  572. min: 8,
  573. // Bcrypt does not support longer passwords than that.
  574. max: 72,
  575. },
  576. },
  577. elevateAccountSecurityAfterFailedLogin:
  578. parseInt(process.env.ELEVATED_ACCOUNT_SECURITY_AFTER_FAILED_LOGIN_MS, 10) ||
  579. 24 * 60 * 60 * 1000,
  580. deviceHistory: {
  581. cookieName: process.env.DEVICE_HISTORY_COOKIE_NAME || 'deviceHistory',
  582. entryExpiry:
  583. parseInt(process.env.DEVICE_HISTORY_ENTRY_EXPIRY_MS, 10) ||
  584. 90 * 24 * 60 * 60 * 1000,
  585. maxEntries: parseInt(process.env.DEVICE_HISTORY_MAX_ENTRIES, 10) || 10,
  586. secret: process.env.DEVICE_HISTORY_SECRET,
  587. },
  588. // Email support
  589. // -------------
  590. //
  591. // Overleaf uses nodemailer (http://www.nodemailer.com/) to send transactional emails.
  592. // To see the range of transport and options they support, see http://www.nodemailer.com/docs/transports
  593. // email:
  594. // fromAddress: ""
  595. // replyTo: ""
  596. // lifecycle: false
  597. // # Example transport and parameter settings for Amazon SES
  598. // transport: "SES"
  599. // parameters:
  600. // AWSAccessKeyID: ""
  601. // AWSSecretKey: ""
  602. // For legacy reasons, we need to populate this object.
  603. sentry: {},
  604. // Production Settings
  605. // -------------------
  606. debugPugTemplates: process.env.DEBUG_PUG_TEMPLATES === 'true',
  607. precompilePugTemplatesAtBootTime: process.env
  608. .PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME
  609. ? process.env.PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME === 'true'
  610. : process.env.NODE_ENV === 'production',
  611. // Should javascript assets be served minified or not.
  612. useMinifiedJs: process.env.MINIFIED_JS === 'true' || false,
  613. // Should static assets be sent with a header to tell the browser to cache
  614. // them.
  615. cacheStaticAssets: false,
  616. // If you are running Overleaf over https, set this to true to send the
  617. // cookie with a secure flag (recommended).
  618. secureCookie: false,
  619. // 'SameSite' cookie setting. Can be set to 'lax', 'none' or 'strict'
  620. // 'lax' is recommended, as 'strict' will prevent people linking to projects
  621. // https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7
  622. sameSiteCookie: 'lax',
  623. // If you are running Overleaf behind a proxy (like Apache, Nginx, etc)
  624. // then set this to true to allow it to correctly detect the forwarded IP
  625. // address and http/https protocol information.
  626. behindProxy: true,
  627. trustedProxyIps: process.env.TRUSTED_PROXY_IPS || 'loopback',
  628. // Delay before closing the http server upon receiving a SIGTERM process signal.
  629. gracefulShutdownDelayInMs:
  630. parseInt(process.env.GRACEFUL_SHUTDOWN_DELAY_SECONDS ?? '5', 10) * seconds,
  631. maxReconnectGracefullyIntervalMs: parseInt(
  632. process.env.MAX_RECONNECT_GRACEFULLY_INTERVAL_MS ?? '30000',
  633. 10
  634. ),
  635. // Expose the hostname in the `X-Served-By` response header
  636. exposeHostname: process.env.EXPOSE_HOSTNAME === 'true',
  637. // Cookie max age (in milliseconds). Set to false for a browser session.
  638. cookieSessionLength: 5 * 24 * 60 * 60 * 1000, // 5 days
  639. // When true, only allow invites to be sent to email addresses that
  640. // already have user accounts
  641. restrictInvitesToExistingAccounts: false,
  642. // Should we allow access to any page without logging in? This includes
  643. // public projects, /learn, /templates, about pages, etc.
  644. allowPublicAccess: process.env.OVERLEAF_ALLOW_PUBLIC_ACCESS === 'true',
  645. // editor should be open by default
  646. editorIsOpen: process.env.EDITOR_OPEN !== 'false',
  647. // site should be open by default
  648. siteIsOpen: process.env.SITE_OPEN !== 'false',
  649. // status file for closing/opening the site at run-time, polled every 5s
  650. siteMaintenanceFile: process.env.SITE_MAINTENANCE_FILE,
  651. // Use a single compile directory for all users in a project
  652. // (otherwise each user has their own directory)
  653. // disablePerUserCompiles: true
  654. // Domain the client (pdfjs) should download the compiled pdf from
  655. pdfDownloadDomain: process.env.COMPILES_USER_CONTENT_DOMAIN, // "http://clsi-lb:3014"
  656. // By default turn on feature flag, can be overridden per request.
  657. enablePdfCaching: process.env.ENABLE_PDF_CACHING === 'true',
  658. // Maximum size of text documents in the real-time editing system.
  659. max_doc_length: 2 * 1024 * 1024, // 2mb
  660. primary_email_check_expiration: 1000 * 60 * 60 * 24 * 90, // 90 days
  661. userHardDeletionDelay:
  662. parseInt(process.env.OVERLEAF_USER_HARD_DELETION_DELAY, 10) ||
  663. 1000 * 60 * 60 * 24 * 90, // 90 days
  664. projectHardDeletionDelay:
  665. parseInt(process.env.OVERLEAF_PROJECT_HARD_DELETION_DELAY, 10) ||
  666. 1000 * 60 * 60 * 24 * 90, // 90 days
  667. // Maximum Delay before sending comment mention notifications
  668. notificationMaxDelay:
  669. parseInt(process.env.COMMENT_MENTION_DELAY_MS) || 30 * 60 * 1000, // 30 minutes
  670. // Comment mention notifications will wait at least this long before being sent
  671. notificationMinDelay:
  672. parseInt(process.env.COMMENT_MENTION_DELAY_MS) || 10 * 60 * 1000, // 10 minutes
  673. // Maximum JSON size in HTTP requests
  674. // We should be able to process twice the max doc length, to allow for
  675. // - the doc content
  676. // - text ranges spanning the whole doc
  677. //
  678. // There's also overhead required for the JSON encoding and the UTF-8
  679. // encoding, theoretically up to 6 times the max doc length (e.g. a document
  680. // entirely filled with "\u0011" characters). On the other hand, we don't want
  681. // to block the event loop with JSON parsing, so we try to find a practical
  682. // compromise.
  683. max_json_request_size:
  684. parseInt(process.env.MAX_JSON_REQUEST_SIZE) || 12 * 1024 * 1024, // 12 MB
  685. // Internal configs
  686. // ----------------
  687. path: {
  688. // If we ever need to write something to disk (e.g. incoming requests
  689. // that need processing but may be too big for memory, then write
  690. // them to disk here).
  691. dumpFolder: Path.resolve(__dirname, '../data/dumpFolder'),
  692. uploadFolder: Path.resolve(__dirname, '../data/uploads'),
  693. },
  694. // Automatic Snapshots
  695. // -------------------
  696. automaticSnapshots: {
  697. // How long should we wait after the user last edited to
  698. // take a snapshot?
  699. waitTimeAfterLastEdit: 5 * minutes,
  700. // Even if edits are still taking place, this is maximum
  701. // time to wait before taking another snapshot.
  702. maxTimeBetweenSnapshots: 30 * minutes,
  703. },
  704. // Smoke test
  705. // ----------
  706. // Provide log in credentials and a project to be able to run
  707. // some basic smoke tests to check the core functionality.
  708. //
  709. smokeTest: {
  710. userId: process.env.SMOKE_TEST_USER_ID,
  711. },
  712. appName: process.env.APP_NAME || 'Overleaf (Community Edition)',
  713. adminEmail: process.env.ADMIN_EMAIL || 'placeholder@example.com',
  714. adminDomains: process.env.ADMIN_DOMAINS
  715. ? JSON.parse(process.env.ADMIN_DOMAINS)
  716. : undefined,
  717. nav: {
  718. title: process.env.APP_NAME || 'Overleaf Community Edition',
  719. hide_powered_by: process.env.NAV_HIDE_POWERED_BY === 'true',
  720. left_footer: [],
  721. right_footer: [
  722. {
  723. text: '<a href="https://github.com/overleaf/overleaf">Fork on GitHub!</a>',
  724. },
  725. ],
  726. showSubscriptionLink: false,
  727. header_extras: [],
  728. },
  729. // Example:
  730. // header_extras: [{text: "Some Page", url: "http://example.com/some/page", class: "subdued"}]
  731. recaptcha: {
  732. endpoint:
  733. process.env.RECAPTCHA_ENDPOINT ||
  734. 'https://www.google.com/recaptcha/api/siteverify',
  735. trustedUsers: (process.env.CAPTCHA_TRUSTED_USERS || '')
  736. .split(',')
  737. .map(x => x.trim())
  738. .filter(x => x !== ''),
  739. trustedUsersRegex: process.env.CAPTCHA_TRUSTED_USERS_REGEX
  740. ? // Enforce matching of the entire input.
  741. new RegExp(`^${process.env.CAPTCHA_TRUSTED_USERS_REGEX}$`)
  742. : null,
  743. disabled: {
  744. invite: true,
  745. login: true,
  746. passwordReset: true,
  747. register: true,
  748. addEmail: true,
  749. },
  750. },
  751. customisation: {},
  752. redirects: {
  753. '/templates/index': '/templates/',
  754. },
  755. enablePugCache: process.env.ENABLE_PUG_CACHE === 'true',
  756. reloadModuleViewsOnEachRequest:
  757. process.env.ENABLE_PUG_CACHE !== 'true' &&
  758. process.env.NODE_ENV === 'development',
  759. rateLimit: {
  760. subnetRateLimiterDisabled:
  761. process.env.SUBNET_RATE_LIMITER_DISABLED === 'true',
  762. autoCompile: {
  763. everyone: process.env.RATE_LIMIT_AUTO_COMPILE_EVERYONE || 100,
  764. standard: process.env.RATE_LIMIT_AUTO_COMPILE_STANDARD || 25,
  765. },
  766. login: {
  767. ip: { points: 20, subnetPoints: 200, duration: 60 },
  768. email: { points: 10, duration: 120 },
  769. },
  770. },
  771. analytics: {
  772. enabled: false,
  773. },
  774. compileBodySizeLimitMb: process.env.COMPILE_BODY_SIZE_LIMIT_MB || 7,
  775. textExtensions: defaultTextExtensions.concat(
  776. parseTextExtensions(process.env.ADDITIONAL_TEXT_EXTENSIONS)
  777. ),
  778. // case-insensitive file names that is editable (doc) in the editor
  779. editableFilenames: ['latexmkrc', '.latexmkrc', 'makefile', 'gnumakefile'],
  780. fileIgnorePattern:
  781. process.env.FILE_IGNORE_PATTERN ||
  782. '**/{{__MACOSX,.git,.texpadtmp,.R}{,/**},.!(latexmkrc),*.{dvi,aux,log,toc,out,pdfsync,synctex,synctex(busy),fdb_latexmk,fls,nlo,ind,glo,gls,glg,bbl,blg,doc,docx,gz,swp}}',
  783. validRootDocExtensions: ['tex', 'Rtex', 'ltx', 'Rnw'],
  784. emailConfirmationDisabled:
  785. process.env.EMAIL_CONFIRMATION_DISABLED === 'true' || false,
  786. emailAddressLimit: intFromEnv('EMAIL_ADDRESS_LIMIT', 10),
  787. enabledServices: (process.env.ENABLED_SERVICES || 'web,api')
  788. .split(',')
  789. .map(s => s.trim()),
  790. // module options
  791. // ----------
  792. modules: {
  793. sanitize: {
  794. options: {
  795. allowedTags: [
  796. 'h1',
  797. 'h2',
  798. 'h3',
  799. 'h4',
  800. 'h5',
  801. 'h6',
  802. 'blockquote',
  803. 'p',
  804. 'a',
  805. 'ul',
  806. 'ol',
  807. 'nl',
  808. 'li',
  809. 'b',
  810. 'i',
  811. 'strong',
  812. 'em',
  813. 'strike',
  814. 'code',
  815. 'hr',
  816. 'br',
  817. 'div',
  818. 'table',
  819. 'thead',
  820. 'col',
  821. 'caption',
  822. 'tbody',
  823. 'tr',
  824. 'th',
  825. 'td',
  826. 'tfoot',
  827. 'pre',
  828. 'iframe',
  829. 'img',
  830. 'figure',
  831. 'figcaption',
  832. 'span',
  833. 'source',
  834. 'track',
  835. 'video',
  836. 'del',
  837. ],
  838. allowedAttributes: {
  839. a: [
  840. 'href',
  841. 'name',
  842. 'target',
  843. 'class',
  844. 'event-tracking',
  845. 'event-tracking-ga',
  846. 'event-tracking-label',
  847. 'event-tracking-trigger',
  848. ],
  849. div: ['class', 'id', 'style'],
  850. h1: ['class', 'id'],
  851. h2: ['class', 'id'],
  852. h3: ['class', 'id'],
  853. h4: ['class', 'id'],
  854. h5: ['class', 'id'],
  855. h6: ['class', 'id'],
  856. p: ['class'],
  857. col: ['width'],
  858. figure: ['class', 'id', 'style'],
  859. figcaption: ['class', 'id', 'style'],
  860. i: ['aria-hidden', 'aria-label', 'class', 'id', 'translate'],
  861. iframe: [
  862. 'allowfullscreen',
  863. 'frameborder',
  864. 'height',
  865. 'src',
  866. 'style',
  867. 'width',
  868. ],
  869. img: ['alt', 'class', 'src', 'style'],
  870. source: ['src', 'type'],
  871. span: ['class', 'id', 'style'],
  872. strong: ['style'],
  873. table: ['border', 'class', 'id', 'style'],
  874. td: ['colspan', 'rowspan', 'headers', 'style'],
  875. th: [
  876. 'abbr',
  877. 'headers',
  878. 'colspan',
  879. 'rowspan',
  880. 'scope',
  881. 'sorted',
  882. 'style',
  883. ],
  884. tr: ['class'],
  885. track: ['src', 'kind', 'srcLang', 'label'],
  886. video: ['alt', 'class', 'controls', 'height', 'width'],
  887. },
  888. },
  889. },
  890. },
  891. overleafModuleImports: {
  892. // modules to import (an empty array for each set of modules)
  893. //
  894. // Restart webpack after making changes.
  895. //
  896. createFileModes: [],
  897. devToolbar: [],
  898. gitBridge: [],
  899. publishModal: [],
  900. tprFileViewInfo: [],
  901. tprFileViewRefreshError: [],
  902. tprFileViewRefreshButton: [],
  903. tprFileViewNotOriginalImporter: [],
  904. contactUsModal: [],
  905. sourceEditorExtensions: [],
  906. sourceEditorComponents: [],
  907. pdfLogEntryHeaderActionComponents: [],
  908. pdfLogEntryComponents: [],
  909. pdfLogEntriesComponents: [],
  910. pdfPreviewPromotions: [],
  911. diagnosticActions: [],
  912. sourceEditorCompletionSources: [],
  913. sourceEditorSymbolPalette: [],
  914. sourceEditorToolbarComponents: [],
  915. sourceEditorToolbarEndButtons: [],
  916. rootContextProviders: [],
  917. mainEditorLayoutModals: [],
  918. mainEditorLayoutPanels: [],
  919. langFeedbackLinkingWidgets: [],
  920. labsExperiments: [],
  921. integrationLinkingWidgets: [],
  922. referenceLinkingWidgets: [],
  923. importProjectFromGithubModalWrapper: [],
  924. importProjectFromGithubMenu: [],
  925. editorLeftMenuSync: [],
  926. editorLeftMenuManageTemplate: [],
  927. menubarExtraComponents: [],
  928. oauth2Server: [],
  929. managedGroupSubscriptionEnrollmentNotification: [],
  930. managedGroupEnrollmentInvite: [],
  931. ssoCertificateInfo: [],
  932. v1ImportDataScreen: [],
  933. snapshotUtils: [],
  934. visualEditorProviders: [],
  935. usGovBanner: [],
  936. rollingBuildsUpdatedAlert: [],
  937. offlineModeToolbarButtons: [],
  938. settingsEntries: [],
  939. autoCompleteExtensions: [],
  940. sectionTitleGenerators: [],
  941. toastGenerators: [
  942. Path.resolve(
  943. __dirname,
  944. '../frontend/js/features/pdf-preview/components/synctex-toasts'
  945. ),
  946. ],
  947. editorSidebarComponents: [
  948. Path.resolve(
  949. __dirname,
  950. '../modules/full-project-search/frontend/js/components/full-project-search.tsx'
  951. ),
  952. ],
  953. fileTreeToolbarComponents: [
  954. Path.resolve(
  955. __dirname,
  956. '../modules/full-project-search/frontend/js/components/full-project-search-button.tsx'
  957. ),
  958. ],
  959. fullProjectSearchPanel: [
  960. Path.resolve(
  961. __dirname,
  962. '../modules/full-project-search/frontend/js/components/full-project-search.tsx'
  963. ),
  964. ],
  965. integrationPanelComponents: [],
  966. referenceSearchSetting: [],
  967. settingsModalEditorTabSections: [],
  968. errorLogsComponents: [],
  969. referenceIndices: [],
  970. railEntries: [],
  971. railPopovers: [],
  972. },
  973. moduleImportSequence: [
  974. 'history-v1',
  975. 'launchpad',
  976. 'server-ce-scripts',
  977. 'user-activate',
  978. ],
  979. viewIncludes: {},
  980. csp: {
  981. enabled: process.env.CSP_ENABLED === 'true',
  982. reportOnly: process.env.CSP_REPORT_ONLY === 'true',
  983. reportPercentage: parseFloat(process.env.CSP_REPORT_PERCENTAGE) || 0,
  984. reportUri: process.env.CSP_REPORT_URI,
  985. exclude: [],
  986. viewDirectives: {
  987. 'app/views/project/ide-react': [`img-src 'self' data: blob:`],
  988. },
  989. },
  990. unsupportedBrowsers: {
  991. ie: '<=11',
  992. safari: '<=14',
  993. firefox: '<=78',
  994. },
  995. // ID of the IEEE brand in the rails app
  996. ieeeBrandId: intFromEnv('IEEE_BRAND_ID', 15),
  997. managedUsers: {
  998. enabled: false,
  999. },
  1000. enablePandocConversions: process.env.ENABLE_PANDOC_CONVERSIONS === 'true',
  1001. }
  1002. module.exports.mergeWith = function (overrides) {
  1003. return merge(overrides, module.exports)
  1004. }