settings.defaults.js 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  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. spelling: {
  210. url: `http://${process.env.SPELLING_HOST || '127.0.0.1'}:3005`,
  211. host: process.env.SPELLING_HOST,
  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. // url: "http://#{process.env['CLSI_LB_HOST']}:3014"
  226. backendGroupName: undefined,
  227. submissionBackendClass:
  228. process.env.CLSI_SUBMISSION_BACKEND_CLASS || 'n2d',
  229. },
  230. project_history: {
  231. sendProjectStructureOps: true,
  232. url: `http://${process.env.PROJECT_HISTORY_HOST || '127.0.0.1'}:3054`,
  233. },
  234. realTime: {
  235. url: `http://${process.env.REALTIME_HOST || '127.0.0.1'}:3026`,
  236. },
  237. contacts: {
  238. url: `http://${process.env.CONTACTS_HOST || '127.0.0.1'}:3036`,
  239. },
  240. notifications: {
  241. url: `http://${process.env.NOTIFICATIONS_HOST || '127.0.0.1'}:3042`,
  242. },
  243. webpack: {
  244. url: `http://${process.env.WEBPACK_HOST || '127.0.0.1'}:3808`,
  245. },
  246. wiki: {
  247. url: process.env.WIKI_URL || 'https://learn.sharelatex.com',
  248. maxCacheAge: parseInt(process.env.WIKI_MAX_CACHE_AGE || 5 * minutes, 10),
  249. },
  250. haveIBeenPwned: {
  251. enabled: process.env.HAVE_I_BEEN_PWNED_ENABLED === 'true',
  252. url:
  253. process.env.HAVE_I_BEEN_PWNED_URL || 'https://api.pwnedpasswords.com',
  254. timeout: parseInt(process.env.HAVE_I_BEEN_PWNED_TIMEOUT, 10) || 5 * 1000,
  255. },
  256. // For legacy reasons, we need to populate the below objects.
  257. v1: {},
  258. recurly: {},
  259. },
  260. // Defines which features are allowed in the
  261. // Permissions-Policy HTTP header
  262. httpPermissions: httpPermissionsPolicy,
  263. useHttpPermissionsPolicy: true,
  264. jwt: {
  265. key: process.env.OT_JWT_AUTH_KEY,
  266. algorithm: process.env.OT_JWT_AUTH_ALG || 'HS256',
  267. },
  268. devToolbar: {
  269. enabled: false,
  270. },
  271. splitTests: [],
  272. // Where your instance of Overleaf Community Edition/Server Pro can be found publicly. Used in emails
  273. // that are sent out, generated links, etc.
  274. siteUrl: (siteUrl = process.env.PUBLIC_URL || 'http://127.0.0.1:3000'),
  275. lockManager: {
  276. lockTestInterval: intFromEnv('LOCK_MANAGER_LOCK_TEST_INTERVAL', 50),
  277. maxTestInterval: intFromEnv('LOCK_MANAGER_MAX_TEST_INTERVAL', 1000),
  278. maxLockWaitTime: intFromEnv('LOCK_MANAGER_MAX_LOCK_WAIT_TIME', 10000),
  279. redisLockExpiry: intFromEnv('LOCK_MANAGER_REDIS_LOCK_EXPIRY', 30),
  280. slowExecutionThreshold: intFromEnv(
  281. 'LOCK_MANAGER_SLOW_EXECUTION_THRESHOLD',
  282. 5000
  283. ),
  284. },
  285. // Optional separate location for websocket connections, if unset defaults to siteUrl.
  286. wsUrl: process.env.WEBSOCKET_URL,
  287. wsUrlV2: process.env.WEBSOCKET_URL_V2,
  288. wsUrlBeta: process.env.WEBSOCKET_URL_BETA,
  289. wsUrlV2Percentage: parseInt(
  290. process.env.WEBSOCKET_URL_V2_PERCENTAGE || '0',
  291. 10
  292. ),
  293. wsRetryHandshake: parseInt(process.env.WEBSOCKET_RETRY_HANDSHAKE || '5', 10),
  294. // cookie domain
  295. // use full domain for cookies to only be accessible from that domain,
  296. // replace subdomain with dot to have them accessible on all subdomains
  297. cookieDomain: process.env.COOKIE_DOMAIN,
  298. cookieName: process.env.COOKIE_NAME || 'overleaf.sid',
  299. cookieRollingSession: true,
  300. // this is only used if cookies are used for clsi backend
  301. // clsiCookieKey: "clsiserver"
  302. robotsNoindex: process.env.ROBOTS_NOINDEX === 'true' || false,
  303. maxEntitiesPerProject: parseInt(
  304. process.env.MAX_ENTITIES_PER_PROJECT || '2000',
  305. 10
  306. ),
  307. projectUploadTimeout: parseInt(
  308. process.env.PROJECT_UPLOAD_TIMEOUT || '120000',
  309. 10
  310. ),
  311. maxUploadSize: 50 * 1024 * 1024, // 50 MB
  312. multerOptions: {
  313. preservePath: process.env.MULTER_PRESERVE_PATH,
  314. },
  315. // start failing the health check if active handles exceeds this limit
  316. maxActiveHandles: process.env.MAX_ACTIVE_HANDLES
  317. ? parseInt(process.env.MAX_ACTIVE_HANDLES, 10)
  318. : undefined,
  319. // Security
  320. // --------
  321. security: {
  322. sessionSecret: process.env.SESSION_SECRET,
  323. sessionSecretUpcoming: process.env.SESSION_SECRET_UPCOMING,
  324. sessionSecretFallback: process.env.SESSION_SECRET_FALLBACK,
  325. bcryptRounds: parseInt(process.env.BCRYPT_ROUNDS, 10) || 12,
  326. }, // number of rounds used to hash user passwords (raised to power 2)
  327. adminUrl: process.env.ADMIN_URL,
  328. adminOnlyLogin: process.env.ADMIN_ONLY_LOGIN === 'true',
  329. adminPrivilegeAvailable: process.env.ADMIN_PRIVILEGE_AVAILABLE === 'true',
  330. blockCrossOriginRequests: process.env.BLOCK_CROSS_ORIGIN_REQUESTS === 'true',
  331. allowedOrigins: (process.env.ALLOWED_ORIGINS || siteUrl).split(','),
  332. httpAuthUsers,
  333. // Default features
  334. // ----------------
  335. //
  336. // You can select the features that are enabled by default for new
  337. // new users.
  338. defaultFeatures: (defaultFeatures = {
  339. collaborators: -1,
  340. dropbox: true,
  341. github: true,
  342. gitBridge: true,
  343. versioning: true,
  344. compileTimeout: 180,
  345. compileGroup: 'standard',
  346. references: true,
  347. trackChanges: true,
  348. }),
  349. // featuresEpoch: 'YYYY-MM-DD',
  350. features: {
  351. personal: defaultFeatures,
  352. },
  353. groupPlanModalOptions: {
  354. plan_codes: [],
  355. currencies: [],
  356. sizes: [],
  357. usages: [],
  358. },
  359. plans: [
  360. {
  361. planCode: 'personal',
  362. name: 'Personal',
  363. price_in_cents: 0,
  364. features: defaultFeatures,
  365. },
  366. ],
  367. enableSubscriptions: false,
  368. restrictedCountries: [],
  369. enableOnboardingEmails: process.env.ENABLE_ONBOARDING_EMAILS === 'true',
  370. enabledLinkedFileTypes: (process.env.ENABLED_LINKED_FILE_TYPES || '').split(
  371. ','
  372. ),
  373. // i18n
  374. // ------
  375. //
  376. i18n: {
  377. checkForHTMLInVars: process.env.I18N_CHECK_FOR_HTML_IN_VARS === 'true',
  378. escapeHTMLInVars: process.env.I18N_ESCAPE_HTML_IN_VARS === 'true',
  379. subdomainLang: {
  380. www: { lngCode: 'en', url: siteUrl },
  381. },
  382. defaultLng: 'en',
  383. },
  384. // Spelling languages
  385. // ------------------
  386. //
  387. // You must have the corresponding aspell package installed to
  388. // be able to use a language.
  389. languages: [
  390. { code: 'en', name: 'English' },
  391. { code: 'en_US', name: 'English (American)' },
  392. { code: 'en_GB', name: 'English (British)' },
  393. { code: 'en_CA', name: 'English (Canadian)' },
  394. { code: 'af', name: 'Afrikaans' },
  395. { code: 'ar', name: 'Arabic' },
  396. { code: 'gl', name: 'Galician' },
  397. { code: 'eu', name: 'Basque' },
  398. { code: 'br', name: 'Breton' },
  399. { code: 'bg', name: 'Bulgarian' },
  400. { code: 'ca', name: 'Catalan' },
  401. { code: 'hr', name: 'Croatian' },
  402. { code: 'cs', name: 'Czech' },
  403. { code: 'da', name: 'Danish' },
  404. { code: 'nl', name: 'Dutch' },
  405. { code: 'eo', name: 'Esperanto' },
  406. { code: 'et', name: 'Estonian' },
  407. { code: 'fo', name: 'Faroese' },
  408. { code: 'fr', name: 'French' },
  409. { code: 'de', name: 'German' },
  410. { code: 'el', name: 'Greek' },
  411. { code: 'id', name: 'Indonesian' },
  412. { code: 'ga', name: 'Irish' },
  413. { code: 'it', name: 'Italian' },
  414. { code: 'kk', name: 'Kazakh' },
  415. { code: 'ku', name: 'Kurdish' },
  416. { code: 'lv', name: 'Latvian' },
  417. { code: 'lt', name: 'Lithuanian' },
  418. { code: 'nr', name: 'Ndebele' },
  419. { code: 'ns', name: 'Northern Sotho' },
  420. { code: 'no', name: 'Norwegian' },
  421. { code: 'fa', name: 'Persian' },
  422. { code: 'pl', name: 'Polish' },
  423. { code: 'pt_BR', name: 'Portuguese (Brazilian)' },
  424. { code: 'pt_PT', name: 'Portuguese (European)' },
  425. { code: 'pa', name: 'Punjabi' },
  426. { code: 'ro', name: 'Romanian' },
  427. { code: 'ru', name: 'Russian' },
  428. { code: 'sk', name: 'Slovak' },
  429. { code: 'sl', name: 'Slovenian' },
  430. { code: 'st', name: 'Southern Sotho' },
  431. { code: 'es', name: 'Spanish' },
  432. { code: 'sv', name: 'Swedish' },
  433. { code: 'tl', name: 'Tagalog' },
  434. { code: 'ts', name: 'Tsonga' },
  435. { code: 'tn', name: 'Tswana' },
  436. { code: 'hsb', name: 'Upper Sorbian' },
  437. { code: 'cy', name: 'Welsh' },
  438. { code: 'xh', name: 'Xhosa' },
  439. ],
  440. translatedLanguages: {
  441. cn: '简体中文',
  442. cs: 'Čeština',
  443. da: 'Dansk',
  444. de: 'Deutsch',
  445. en: 'English',
  446. es: 'Español',
  447. fi: 'Suomi',
  448. fr: 'Français',
  449. it: 'Italiano',
  450. ja: '日本語',
  451. ko: '한국어',
  452. nl: 'Nederlands',
  453. no: 'Norsk',
  454. pl: 'Polski',
  455. pt: 'Português',
  456. ro: 'Română',
  457. ru: 'Русский',
  458. sv: 'Svenska',
  459. tr: 'Türkçe',
  460. uk: 'Українська',
  461. 'zh-CN': '简体中文',
  462. },
  463. maxDictionarySize: 1024 * 1024, // 1 MB
  464. // Password Settings
  465. // -----------
  466. // These restrict the passwords users can use when registering
  467. // opts are from http://antelle.github.io/passfield
  468. passwordStrengthOptions: {
  469. length: {
  470. min: 8,
  471. // Bcrypt does not support longer passwords than that.
  472. max: 72,
  473. },
  474. },
  475. elevateAccountSecurityAfterFailedLogin:
  476. parseInt(process.env.ELEVATED_ACCOUNT_SECURITY_AFTER_FAILED_LOGIN_MS, 10) ||
  477. 24 * 60 * 60 * 1000,
  478. deviceHistory: {
  479. cookieName: process.env.DEVICE_HISTORY_COOKIE_NAME || 'deviceHistory',
  480. entryExpiry:
  481. parseInt(process.env.DEVICE_HISTORY_ENTRY_EXPIRY_MS, 10) ||
  482. 90 * 24 * 60 * 60 * 1000,
  483. maxEntries: parseInt(process.env.DEVICE_HISTORY_MAX_ENTRIES, 10) || 10,
  484. secret: process.env.DEVICE_HISTORY_SECRET,
  485. },
  486. // Email support
  487. // -------------
  488. //
  489. // Overleaf uses nodemailer (http://www.nodemailer.com/) to send transactional emails.
  490. // To see the range of transport and options they support, see http://www.nodemailer.com/docs/transports
  491. // email:
  492. // fromAddress: ""
  493. // replyTo: ""
  494. // lifecycle: false
  495. // # Example transport and parameter settings for Amazon SES
  496. // transport: "SES"
  497. // parameters:
  498. // AWSAccessKeyID: ""
  499. // AWSSecretKey: ""
  500. // For legacy reasons, we need to populate this object.
  501. sentry: {},
  502. // Production Settings
  503. // -------------------
  504. debugPugTemplates: process.env.DEBUG_PUG_TEMPLATES === 'true',
  505. precompilePugTemplatesAtBootTime: process.env
  506. .PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME
  507. ? process.env.PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME === 'true'
  508. : process.env.NODE_ENV === 'production',
  509. // Should javascript assets be served minified or not.
  510. useMinifiedJs: process.env.MINIFIED_JS === 'true' || false,
  511. // Should static assets be sent with a header to tell the browser to cache
  512. // them.
  513. cacheStaticAssets: false,
  514. // If you are running Overleaf over https, set this to true to send the
  515. // cookie with a secure flag (recommended).
  516. secureCookie: false,
  517. // 'SameSite' cookie setting. Can be set to 'lax', 'none' or 'strict'
  518. // 'lax' is recommended, as 'strict' will prevent people linking to projects
  519. // https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7
  520. sameSiteCookie: 'lax',
  521. // If you are running Overleaf behind a proxy (like Apache, Nginx, etc)
  522. // then set this to true to allow it to correctly detect the forwarded IP
  523. // address and http/https protocol information.
  524. behindProxy: false,
  525. // Delay before closing the http server upon receiving a SIGTERM process signal.
  526. gracefulShutdownDelayInMs:
  527. parseInt(process.env.GRACEFUL_SHUTDOWN_DELAY_SECONDS ?? '5', 10) * seconds,
  528. // Expose the hostname in the `X-Served-By` response header
  529. exposeHostname: process.env.EXPOSE_HOSTNAME === 'true',
  530. // Cookie max age (in milliseconds). Set to false for a browser session.
  531. cookieSessionLength: 5 * 24 * 60 * 60 * 1000, // 5 days
  532. // When true, only allow invites to be sent to email addresses that
  533. // already have user accounts
  534. restrictInvitesToExistingAccounts: false,
  535. // Should we allow access to any page without logging in? This includes
  536. // public projects, /learn, /templates, about pages, etc.
  537. allowPublicAccess: process.env.OVERLEAF_ALLOW_PUBLIC_ACCESS === 'true',
  538. // editor should be open by default
  539. editorIsOpen: process.env.EDITOR_OPEN !== 'false',
  540. // site should be open by default
  541. siteIsOpen: process.env.SITE_OPEN !== 'false',
  542. // status file for closing/opening the site at run-time, polled every 5s
  543. siteMaintenanceFile: process.env.SITE_MAINTENANCE_FILE,
  544. // Use a single compile directory for all users in a project
  545. // (otherwise each user has their own directory)
  546. // disablePerUserCompiles: true
  547. // Domain the client (pdfjs) should download the compiled pdf from
  548. pdfDownloadDomain: process.env.COMPILES_USER_CONTENT_DOMAIN, // "http://clsi-lb:3014"
  549. // By default turn on feature flag, can be overridden per request.
  550. enablePdfCaching: process.env.ENABLE_PDF_CACHING === 'true',
  551. // Maximum size of text documents in the real-time editing system.
  552. max_doc_length: 2 * 1024 * 1024, // 2mb
  553. primary_email_check_expiration: 1000 * 60 * 60 * 24 * 90, // 90 days
  554. // Maximum JSON size in HTTP requests
  555. // We should be able to process twice the max doc length, to allow for
  556. // - the doc content
  557. // - text ranges spanning the whole doc
  558. //
  559. // There's also overhead required for the JSON encoding and the UTF-8 encoding,
  560. // theoretically up to 3 times the max doc length. On the other hand, we don't
  561. // want to block the event loop with JSON parsing, so we try to find a
  562. // practical compromise.
  563. max_json_request_size:
  564. parseInt(process.env.MAX_JSON_REQUEST_SIZE) || 6 * 1024 * 1024, // 6 MB
  565. // Internal configs
  566. // ----------------
  567. path: {
  568. // If we ever need to write something to disk (e.g. incoming requests
  569. // that need processing but may be too big for memory, then write
  570. // them to disk here).
  571. dumpFolder: Path.resolve(__dirname, '../data/dumpFolder'),
  572. uploadFolder: Path.resolve(__dirname, '../data/uploads'),
  573. },
  574. // Automatic Snapshots
  575. // -------------------
  576. automaticSnapshots: {
  577. // How long should we wait after the user last edited to
  578. // take a snapshot?
  579. waitTimeAfterLastEdit: 5 * minutes,
  580. // Even if edits are still taking place, this is maximum
  581. // time to wait before taking another snapshot.
  582. maxTimeBetweenSnapshots: 30 * minutes,
  583. },
  584. // Smoke test
  585. // ----------
  586. // Provide log in credentials and a project to be able to run
  587. // some basic smoke tests to check the core functionality.
  588. //
  589. smokeTest: {
  590. user: process.env.SMOKE_TEST_USER,
  591. userId: process.env.SMOKE_TEST_USER_ID,
  592. password: process.env.SMOKE_TEST_PASSWORD,
  593. projectId: process.env.SMOKE_TEST_PROJECT_ID,
  594. rateLimitSubject: process.env.SMOKE_TEST_RATE_LIMIT_SUBJECT || '127.0.0.1',
  595. stepTimeout: parseInt(process.env.SMOKE_TEST_STEP_TIMEOUT || '10000', 10),
  596. },
  597. appName: process.env.APP_NAME || 'Overleaf (Community Edition)',
  598. adminEmail: process.env.ADMIN_EMAIL || 'placeholder@example.com',
  599. adminDomains: process.env.ADMIN_DOMAINS
  600. ? JSON.parse(process.env.ADMIN_DOMAINS)
  601. : undefined,
  602. nav: {
  603. title: process.env.APP_NAME || 'Overleaf Community Edition',
  604. hide_powered_by: process.env.NAV_HIDE_POWERED_BY === 'true',
  605. left_footer: [],
  606. right_footer: [
  607. {
  608. text: "<i class='fa fa-github-square'></i> Fork on GitHub!",
  609. url: 'https://github.com/overleaf/overleaf',
  610. },
  611. ],
  612. showSubscriptionLink: false,
  613. header_extras: [],
  614. },
  615. // Example:
  616. // header_extras: [{text: "Some Page", url: "http://example.com/some/page", class: "subdued"}]
  617. recaptcha: {
  618. endpoint:
  619. process.env.RECAPTCHA_ENDPOINT ||
  620. 'https://www.google.com/recaptcha/api/siteverify',
  621. trustedUsers: (process.env.CAPTCHA_TRUSTED_USERS || '')
  622. .split(',')
  623. .map(x => x.trim())
  624. .filter(x => x !== ''),
  625. disabled: {
  626. invite: true,
  627. login: true,
  628. passwordReset: true,
  629. register: true,
  630. addEmail: true,
  631. },
  632. },
  633. customisation: {},
  634. redirects: {
  635. '/templates/index': '/templates/',
  636. },
  637. reloadModuleViewsOnEachRequest: process.env.NODE_ENV === 'development',
  638. rateLimit: {
  639. autoCompile: {
  640. everyone: process.env.RATE_LIMIT_AUTO_COMPILE_EVERYONE || 100,
  641. standard: process.env.RATE_LIMIT_AUTO_COMPILE_STANDARD || 25,
  642. },
  643. },
  644. analytics: {
  645. enabled: false,
  646. },
  647. compileBodySizeLimitMb: process.env.COMPILE_BODY_SIZE_LIMIT_MB || 7,
  648. textExtensions: defaultTextExtensions.concat(
  649. parseTextExtensions(process.env.ADDITIONAL_TEXT_EXTENSIONS)
  650. ),
  651. // case-insensitive file names that is editable (doc) in the editor
  652. editableFilenames: ['latexmkrc', '.latexmkrc', 'makefile', 'gnumakefile'],
  653. fileIgnorePattern:
  654. process.env.FILE_IGNORE_PATTERN ||
  655. '**/{{__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}}',
  656. validRootDocExtensions: ['tex', 'Rtex', 'ltx', 'Rnw'],
  657. emailConfirmationDisabled:
  658. process.env.EMAIL_CONFIRMATION_DISABLED === 'true' || false,
  659. emailAddressLimit: intFromEnv('EMAIL_ADDRESS_LIMIT', 10),
  660. enabledServices: (process.env.ENABLED_SERVICES || 'web,api')
  661. .split(',')
  662. .map(s => s.trim()),
  663. // module options
  664. // ----------
  665. modules: {
  666. sanitize: {
  667. options: {
  668. allowedTags: [
  669. 'h1',
  670. 'h2',
  671. 'h3',
  672. 'h4',
  673. 'h5',
  674. 'h6',
  675. 'blockquote',
  676. 'p',
  677. 'a',
  678. 'ul',
  679. 'ol',
  680. 'nl',
  681. 'li',
  682. 'b',
  683. 'i',
  684. 'strong',
  685. 'em',
  686. 'strike',
  687. 'code',
  688. 'hr',
  689. 'br',
  690. 'div',
  691. 'table',
  692. 'thead',
  693. 'col',
  694. 'caption',
  695. 'tbody',
  696. 'tr',
  697. 'th',
  698. 'td',
  699. 'tfoot',
  700. 'pre',
  701. 'iframe',
  702. 'img',
  703. 'figure',
  704. 'figcaption',
  705. 'span',
  706. 'source',
  707. 'video',
  708. 'del',
  709. ],
  710. allowedAttributes: {
  711. a: [
  712. 'href',
  713. 'name',
  714. 'target',
  715. 'class',
  716. 'event-tracking',
  717. 'event-tracking-ga',
  718. 'event-tracking-label',
  719. 'event-tracking-trigger',
  720. ],
  721. div: ['class', 'id', 'style'],
  722. h1: ['class', 'id'],
  723. h2: ['class', 'id'],
  724. h3: ['class', 'id'],
  725. h4: ['class', 'id'],
  726. h5: ['class', 'id'],
  727. h6: ['class', 'id'],
  728. p: ['class'],
  729. col: ['width'],
  730. figure: ['class', 'id', 'style'],
  731. figcaption: ['class', 'id', 'style'],
  732. i: ['aria-hidden', 'aria-label', 'class', 'id'],
  733. iframe: [
  734. 'allowfullscreen',
  735. 'frameborder',
  736. 'height',
  737. 'src',
  738. 'style',
  739. 'width',
  740. ],
  741. img: ['alt', 'class', 'src', 'style'],
  742. source: ['src', 'type'],
  743. span: ['class', 'id', 'style'],
  744. strong: ['style'],
  745. table: ['border', 'class', 'id', 'style'],
  746. td: ['colspan', 'rowspan', 'headers', 'style'],
  747. th: [
  748. 'abbr',
  749. 'headers',
  750. 'colspan',
  751. 'rowspan',
  752. 'scope',
  753. 'sorted',
  754. 'style',
  755. ],
  756. tr: ['class'],
  757. video: ['alt', 'class', 'controls', 'height', 'width'],
  758. },
  759. },
  760. },
  761. },
  762. overleafModuleImports: {
  763. // modules to import (an empty array for each set of modules)
  764. //
  765. // Restart webpack after making changes.
  766. //
  767. createFileModes: [],
  768. devToolbar: [],
  769. gitBridge: [],
  770. publishModal: [],
  771. tprFileViewInfo: [],
  772. tprFileViewRefreshError: [],
  773. tprFileViewRefreshButton: [],
  774. tprFileViewNotOriginalImporter: [],
  775. newFilePromotions: [],
  776. contactUsModal: [],
  777. editorToolbarButtons: [],
  778. sourceEditorExtensions: [],
  779. sourceEditorComponents: [],
  780. pdfLogEntryComponents: [],
  781. pdfLogEntriesComponents: [],
  782. diagnosticActions: [],
  783. sourceEditorCompletionSources: [],
  784. sourceEditorSymbolPalette: [],
  785. sourceEditorToolbarComponents: [],
  786. editorPromotions: [],
  787. langFeedbackLinkingWidgets: [],
  788. labsExperiments: [],
  789. integrationLinkingWidgets: [],
  790. referenceLinkingWidgets: [],
  791. importProjectFromGithubModalWrapper: [],
  792. importProjectFromGithubMenu: [],
  793. editorLeftMenuSync: [],
  794. editorLeftMenuManageTemplate: [],
  795. oauth2Server: [],
  796. managedGroupSubscriptionEnrollmentNotification: [],
  797. managedGroupEnrollmentInvite: [],
  798. ssoCertificateInfo: [],
  799. },
  800. moduleImportSequence: [
  801. 'history-v1',
  802. 'launchpad',
  803. 'server-ce-scripts',
  804. 'user-activate',
  805. ],
  806. viewIncludes: {},
  807. csp: {
  808. enabled: process.env.CSP_ENABLED === 'true',
  809. reportOnly: process.env.CSP_REPORT_ONLY === 'true',
  810. reportPercentage: parseFloat(process.env.CSP_REPORT_PERCENTAGE) || 0,
  811. reportUri: process.env.CSP_REPORT_URI,
  812. exclude: [],
  813. },
  814. unsupportedBrowsers: {
  815. ie: '<=11',
  816. safari: '<=13',
  817. },
  818. // ID of the IEEE brand in the rails app
  819. ieeeBrandId: intFromEnv('IEEE_BRAND_ID', 15),
  820. managedUsers: {
  821. enabled: false,
  822. },
  823. }
  824. module.exports.mergeWith = function (overrides) {
  825. return merge(overrides, module.exports)
  826. }