settings.defaults.js 31 KB

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