settings.defaults.js 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789
  1. const { merge } = require('@overleaf/settings/merge')
  2. let defaultFeatures, siteUrl
  3. // Make time interval config easier.
  4. const seconds = 1000
  5. const minutes = 60 * seconds
  6. // These credentials are used for authenticating api requests
  7. // between services that may need to go over public channels
  8. const httpAuthUser = process.env.WEB_API_USER
  9. const httpAuthPass = process.env.WEB_API_PASSWORD
  10. const httpAuthUsers = {}
  11. if (httpAuthUser && httpAuthPass) {
  12. httpAuthUsers[httpAuthUser] = httpAuthPass
  13. }
  14. const sessionSecret = process.env.SESSION_SECRET || 'secret-please-change'
  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. 'latexmkrc',
  41. 'lbx',
  42. 'bbx',
  43. 'cbx',
  44. 'm',
  45. 'lco',
  46. 'dtx',
  47. 'ins',
  48. 'ist',
  49. 'def',
  50. 'clo',
  51. 'ldf',
  52. 'rmd',
  53. 'lua',
  54. 'gv',
  55. 'mf',
  56. 'yml',
  57. 'yaml',
  58. ]
  59. const parseTextExtensions = function (extensions) {
  60. if (extensions) {
  61. return extensions.split(',').map(ext => ext.trim())
  62. } else {
  63. return []
  64. }
  65. }
  66. module.exports = {
  67. env: 'server-ce',
  68. limits: {
  69. httpGlobalAgentMaxSockets: 300,
  70. httpsGlobalAgentMaxSockets: 300,
  71. },
  72. allowAnonymousReadAndWriteSharing:
  73. process.env.SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING === 'true',
  74. // Databases
  75. // ---------
  76. mongo: {
  77. options: {
  78. appname: 'web',
  79. useUnifiedTopology:
  80. (process.env.MONGO_USE_UNIFIED_TOPOLOGY || 'true') === 'true',
  81. poolSize: parseInt(process.env.MONGO_POOL_SIZE, 10) || 10,
  82. serverSelectionTimeoutMS:
  83. parseInt(process.env.MONGO_SERVER_SELECTION_TIMEOUT, 10) || 60000,
  84. socketTimeoutMS: parseInt(process.env.MONGO_SOCKET_TIMEOUT, 10) || 30000,
  85. },
  86. url:
  87. process.env.MONGO_CONNECTION_STRING ||
  88. process.env.MONGO_URL ||
  89. `mongodb://${process.env.MONGO_HOST || '127.0.0.1'}/sharelatex`,
  90. },
  91. redis: {
  92. web: {
  93. host: process.env.REDIS_HOST || 'localhost',
  94. port: process.env.REDIS_PORT || '6379',
  95. password: process.env.REDIS_PASSWORD || '',
  96. maxRetriesPerRequest: parseInt(
  97. process.env.REDIS_MAX_RETRIES_PER_REQUEST || '20'
  98. ),
  99. },
  100. // websessions:
  101. // cluster: [
  102. // {host: 'localhost', port: 7000}
  103. // {host: 'localhost', port: 7001}
  104. // {host: 'localhost', port: 7002}
  105. // {host: 'localhost', port: 7003}
  106. // {host: 'localhost', port: 7004}
  107. // {host: 'localhost', port: 7005}
  108. // ]
  109. // ratelimiter:
  110. // cluster: [
  111. // {host: 'localhost', port: 7000}
  112. // {host: 'localhost', port: 7001}
  113. // {host: 'localhost', port: 7002}
  114. // {host: 'localhost', port: 7003}
  115. // {host: 'localhost', port: 7004}
  116. // {host: 'localhost', port: 7005}
  117. // ]
  118. // cooldown:
  119. // cluster: [
  120. // {host: 'localhost', port: 7000}
  121. // {host: 'localhost', port: 7001}
  122. // {host: 'localhost', port: 7002}
  123. // {host: 'localhost', port: 7003}
  124. // {host: 'localhost', port: 7004}
  125. // {host: 'localhost', port: 7005}
  126. // ]
  127. api: {
  128. host: process.env.REDIS_HOST || 'localhost',
  129. port: process.env.REDIS_PORT || '6379',
  130. password: process.env.REDIS_PASSWORD || '',
  131. maxRetriesPerRequest: parseInt(
  132. process.env.REDIS_MAX_RETRIES_PER_REQUEST || '20'
  133. ),
  134. },
  135. },
  136. // Service locations
  137. // -----------------
  138. // Configure which ports to run each service on. Generally you
  139. // can leave these as they are unless you have some other services
  140. // running which conflict, or want to run the web process on port 80.
  141. internal: {
  142. web: {
  143. port: process.env.WEB_PORT || 3000,
  144. host: process.env.LISTEN_ADDRESS || 'localhost',
  145. },
  146. },
  147. // Tell each service where to find the other services. If everything
  148. // is running locally then this is easy, but they exist as separate config
  149. // options incase you want to run some services on remote hosts.
  150. apis: {
  151. web: {
  152. url: `http://${
  153. process.env.WEB_API_HOST || process.env.WEB_HOST || 'localhost'
  154. }:${process.env.WEB_API_PORT || process.env.WEB_PORT || 3000}`,
  155. user: httpAuthUser,
  156. pass: httpAuthPass,
  157. },
  158. documentupdater: {
  159. url: `http://${
  160. process.env.DOCUPDATER_HOST ||
  161. process.env.DOCUMENT_UPDATER_HOST ||
  162. 'localhost'
  163. }:3003`,
  164. },
  165. spelling: {
  166. url: `http://${process.env.SPELLING_HOST || 'localhost'}:3005`,
  167. host: process.env.SPELLING_HOST,
  168. },
  169. trackchanges: {
  170. url: `http://${process.env.TRACK_CHANGES_HOST || 'localhost'}:3015`,
  171. },
  172. docstore: {
  173. url: `http://${process.env.DOCSTORE_HOST || 'localhost'}:3016`,
  174. pubUrl: `http://${process.env.DOCSTORE_HOST || 'localhost'}:3016`,
  175. },
  176. chat: {
  177. internal_url: `http://${process.env.CHAT_HOST || 'localhost'}:3010`,
  178. },
  179. filestore: {
  180. url: `http://${process.env.FILESTORE_HOST || 'localhost'}:3009`,
  181. },
  182. clsi: {
  183. url: `http://${process.env.CLSI_HOST || 'localhost'}:3013`,
  184. // url: "http://#{process.env['CLSI_LB_HOST']}:3014"
  185. backendGroupName: undefined,
  186. },
  187. realTime: {
  188. url: `http://${process.env.REALTIME_HOST || 'localhost'}:3026`,
  189. },
  190. contacts: {
  191. url: `http://${process.env.CONTACTS_HOST || 'localhost'}:3036`,
  192. },
  193. notifications: {
  194. url: `http://${process.env.NOTIFICATIONS_HOST || 'localhost'}:3042`,
  195. },
  196. webpack: {
  197. url: `http://${process.env.WEBPACK_HOST || 'localhost'}:3808`,
  198. },
  199. haveIBeenPwned: {
  200. enabled: process.env.HAVE_I_BEEN_PWNED_ENABLED === 'true',
  201. url:
  202. process.env.HAVE_I_BEEN_PWNED_URL || 'https://api.pwnedpasswords.com',
  203. timeout: parseInt(process.env.HAVE_I_BEEN_PWNED_TIMEOUT, 10) || 5 * 1000,
  204. },
  205. // For legacy reasons, we need to populate the below objects.
  206. v1: {},
  207. recurly: {},
  208. },
  209. splitTests: [],
  210. // Where your instance of ShareLaTeX can be found publically. Used in emails
  211. // that are sent out, generated links, etc.
  212. siteUrl: (siteUrl = process.env.PUBLIC_URL || 'http://localhost:3000'),
  213. lockManager: {
  214. lockTestInterval: intFromEnv('LOCK_MANAGER_LOCK_TEST_INTERVAL', 50),
  215. maxTestInterval: intFromEnv('LOCK_MANAGER_MAX_TEST_INTERVAL', 1000),
  216. maxLockWaitTime: intFromEnv('LOCK_MANAGER_MAX_LOCK_WAIT_TIME', 10000),
  217. redisLockExpiry: intFromEnv('LOCK_MANAGER_REDIS_LOCK_EXPIRY', 30),
  218. slowExecutionThreshold: intFromEnv(
  219. 'LOCK_MANAGER_SLOW_EXECUTION_THRESHOLD',
  220. 5000
  221. ),
  222. },
  223. // Optional separate location for websocket connections, if unset defaults to siteUrl.
  224. wsUrl: process.env.WEBSOCKET_URL,
  225. wsUrlV2: process.env.WEBSOCKET_URL_V2,
  226. wsUrlBeta: process.env.WEBSOCKET_URL_BETA,
  227. wsUrlV2Percentage: parseInt(
  228. process.env.WEBSOCKET_URL_V2_PERCENTAGE || '0',
  229. 10
  230. ),
  231. wsRetryHandshake: parseInt(process.env.WEBSOCKET_RETRY_HANDSHAKE || '5', 10),
  232. // cookie domain
  233. // use full domain for cookies to only be accessible from that domain,
  234. // replace subdomain with dot to have them accessible on all subdomains
  235. cookieDomain: process.env.COOKIE_DOMAIN,
  236. cookieName: process.env.COOKIE_NAME || 'sharelatex.sid',
  237. // this is only used if cookies are used for clsi backend
  238. // clsiCookieKey: "clsiserver"
  239. robotsNoindex: process.env.ROBOTS_NOINDEX === 'true' || false,
  240. maxEntitiesPerProject: 2000,
  241. maxUploadSize: 50 * 1024 * 1024, // 50 MB
  242. // start failing the health check if active handles exceeds this limit
  243. maxActiveHandles: process.env.MAX_ACTIVE_HANDLES
  244. ? parseInt(process.env.MAX_ACTIVE_HANDLES, 10)
  245. : undefined,
  246. // Security
  247. // --------
  248. security: {
  249. sessionSecret,
  250. bcryptRounds: parseInt(process.env.BCRYPT_ROUNDS, 10) || 12,
  251. }, // number of rounds used to hash user passwords (raised to power 2)
  252. httpAuthUsers,
  253. // Default features
  254. // ----------------
  255. //
  256. // You can select the features that are enabled by default for new
  257. // new users.
  258. defaultFeatures: (defaultFeatures = {
  259. collaborators: -1,
  260. dropbox: true,
  261. github: true,
  262. gitBridge: true,
  263. versioning: true,
  264. compileTimeout: 180,
  265. compileGroup: 'standard',
  266. references: true,
  267. templates: true,
  268. trackChanges: true,
  269. }),
  270. // featuresEpoch: 'YYYY-MM-DD',
  271. features: {
  272. personal: defaultFeatures,
  273. },
  274. groupPlanModalOptions: {
  275. plan_codes: [],
  276. currencies: [],
  277. sizes: [],
  278. usages: [],
  279. },
  280. plans: [
  281. {
  282. planCode: 'personal',
  283. name: 'Personal',
  284. price_in_cents: 0,
  285. features: defaultFeatures,
  286. },
  287. ],
  288. enableSubscriptions: false,
  289. enabledLinkedFileTypes: (process.env.ENABLED_LINKED_FILE_TYPES || '').split(
  290. ','
  291. ),
  292. // i18n
  293. // ------
  294. //
  295. i18n: {
  296. checkForHTMLInVars: process.env.I18N_CHECK_FOR_HTML_IN_VARS === 'true',
  297. escapeHTMLInVars: process.env.I18N_ESCAPE_HTML_IN_VARS === 'true',
  298. subdomainLang: {
  299. www: { lngCode: 'en', url: siteUrl },
  300. },
  301. defaultLng: 'en',
  302. },
  303. // Spelling languages
  304. // ------------------
  305. //
  306. // You must have the corresponding aspell package installed to
  307. // be able to use a language.
  308. languages: [
  309. { code: 'en', name: 'English' },
  310. { code: 'en_US', name: 'English (American)' },
  311. { code: 'en_GB', name: 'English (British)' },
  312. { code: 'en_CA', name: 'English (Canadian)' },
  313. { code: 'af', name: 'Afrikaans' },
  314. { code: 'ar', name: 'Arabic' },
  315. { code: 'gl', name: 'Galician' },
  316. { code: 'eu', name: 'Basque' },
  317. { code: 'br', name: 'Breton' },
  318. { code: 'bg', name: 'Bulgarian' },
  319. { code: 'ca', name: 'Catalan' },
  320. { code: 'hr', name: 'Croatian' },
  321. { code: 'cs', name: 'Czech' },
  322. { code: 'da', name: 'Danish' },
  323. { code: 'nl', name: 'Dutch' },
  324. { code: 'eo', name: 'Esperanto' },
  325. { code: 'et', name: 'Estonian' },
  326. { code: 'fo', name: 'Faroese' },
  327. { code: 'fr', name: 'French' },
  328. { code: 'de', name: 'German' },
  329. { code: 'el', name: 'Greek' },
  330. { code: 'id', name: 'Indonesian' },
  331. { code: 'ga', name: 'Irish' },
  332. { code: 'it', name: 'Italian' },
  333. { code: 'kk', name: 'Kazakh' },
  334. { code: 'ku', name: 'Kurdish' },
  335. { code: 'lv', name: 'Latvian' },
  336. { code: 'lt', name: 'Lithuanian' },
  337. { code: 'nr', name: 'Ndebele' },
  338. { code: 'ns', name: 'Northern Sotho' },
  339. { code: 'no', name: 'Norwegian' },
  340. { code: 'fa', name: 'Persian' },
  341. { code: 'pl', name: 'Polish' },
  342. { code: 'pt_BR', name: 'Portuguese (Brazilian)' },
  343. { code: 'pt_PT', name: 'Portuguese (European)' },
  344. { code: 'pa', name: 'Punjabi' },
  345. { code: 'ro', name: 'Romanian' },
  346. { code: 'ru', name: 'Russian' },
  347. { code: 'sk', name: 'Slovak' },
  348. { code: 'sl', name: 'Slovenian' },
  349. { code: 'st', name: 'Southern Sotho' },
  350. { code: 'es', name: 'Spanish' },
  351. { code: 'sv', name: 'Swedish' },
  352. { code: 'tl', name: 'Tagalog' },
  353. { code: 'ts', name: 'Tsonga' },
  354. { code: 'tn', name: 'Tswana' },
  355. { code: 'hsb', name: 'Upper Sorbian' },
  356. { code: 'cy', name: 'Welsh' },
  357. { code: 'xh', name: 'Xhosa' },
  358. ],
  359. translatedLanguages: {
  360. cn: '简体中文',
  361. cs: 'Čeština',
  362. da: 'Dansk',
  363. de: 'Deutsch',
  364. en: 'English',
  365. es: 'Español',
  366. fi: 'Suomi',
  367. fr: 'Français',
  368. it: 'Italiano',
  369. ja: '日本語',
  370. ko: '한국어',
  371. nl: 'Nederlands',
  372. no: 'Norsk',
  373. pl: 'Polski',
  374. pt: 'Português',
  375. ro: 'Română',
  376. ru: 'Русский',
  377. sv: 'Svenska',
  378. tr: 'Türkçe',
  379. uk: 'Українська',
  380. 'zh-CN': '简体中文',
  381. },
  382. maxDictionarySize: 1024 * 1024, // 1 MB
  383. // Password Settings
  384. // -----------
  385. // These restrict the passwords users can use when registering
  386. // opts are from http://antelle.github.io/passfield
  387. passwordStrengthOptions: {
  388. length: {
  389. min: 6,
  390. // Bcrypt does not support longer passwords than that.
  391. max: 72,
  392. },
  393. },
  394. elevateAccountSecurityAfterFailedLogin:
  395. parseInt(process.env.ELEVATED_ACCOUNT_SECURITY_AFTER_FAILED_LOGIN_MS, 10) ||
  396. 24 * 60 * 60 * 1000,
  397. deviceHistory: {
  398. cookieName: process.env.DEVICE_HISTORY_COOKIE_NAME || 'deviceHistory',
  399. entryExpiry:
  400. parseInt(process.env.DEVICE_HISTORY_ENTRY_EXPIRY_MS, 10) ||
  401. 30 * 24 * 60 * 60 * 1000,
  402. maxEntries: parseInt(process.env.DEVICE_HISTORY_MAX_ENTRIES, 10) || 10,
  403. secret: process.env.DEVICE_HISTORY_SECRET,
  404. },
  405. // Email support
  406. // -------------
  407. //
  408. // ShareLaTeX uses nodemailer (http://www.nodemailer.com/) to send transactional emails.
  409. // To see the range of transport and options they support, see http://www.nodemailer.com/docs/transports
  410. // email:
  411. // fromAddress: ""
  412. // replyTo: ""
  413. // lifecycle: false
  414. // # Example transport and parameter settings for Amazon SES
  415. // transport: "SES"
  416. // parameters:
  417. // AWSAccessKeyID: ""
  418. // AWSSecretKey: ""
  419. // For legacy reasons, we need to populate this object.
  420. sentry: {},
  421. // Production Settings
  422. // -------------------
  423. debugPugTemplates: process.env.DEBUG_PUG_TEMPLATES === 'true',
  424. precompilePugTemplatesAtBootTime: process.env
  425. .PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME
  426. ? process.env.PRECOMPILE_PUG_TEMPLATES_AT_BOOT_TIME === 'true'
  427. : process.env.NODE_ENV === 'production',
  428. // Should javascript assets be served minified or not. Note that you will
  429. // need to run `grunt compile:minify` within the web-sharelatex directory
  430. // to generate these.
  431. useMinifiedJs: process.env.MINIFIED_JS === 'true' || false,
  432. // Should static assets be sent with a header to tell the browser to cache
  433. // them.
  434. cacheStaticAssets: false,
  435. // If you are running ShareLaTeX over https, set this to true to send the
  436. // cookie with a secure flag (recommended).
  437. secureCookie: false,
  438. // 'SameSite' cookie setting. Can be set to 'lax', 'none' or 'strict'
  439. // 'lax' is recommended, as 'strict' will prevent people linking to projects
  440. // https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7
  441. sameSiteCookie: 'lax',
  442. // If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  443. // then set this to true to allow it to correctly detect the forwarded IP
  444. // address and http/https protocol information.
  445. behindProxy: false,
  446. // Expose the hostname in the `X-Served-By` response header
  447. exposeHostname: process.env.EXPOSE_HOSTNAME === 'true',
  448. // Cookie max age (in milliseconds). Set to false for a browser session.
  449. cookieSessionLength: 5 * 24 * 60 * 60 * 1000, // 5 days
  450. // When true, only allow invites to be sent to email addresses that
  451. // already have user accounts
  452. restrictInvitesToExistingAccounts: false,
  453. // Should we allow access to any page without logging in? This includes
  454. // public projects, /learn, /templates, about pages, etc.
  455. allowPublicAccess: process.env.SHARELATEX_ALLOW_PUBLIC_ACCESS === 'true',
  456. // editor should be open by default
  457. editorIsOpen: process.env.EDITOR_OPEN !== 'false',
  458. // site should be open by default
  459. siteIsOpen: process.env.SITE_OPEN !== 'false',
  460. // Use a single compile directory for all users in a project
  461. // (otherwise each user has their own directory)
  462. // disablePerUserCompiles: true
  463. // Domain the client (pdfjs) should download the compiled pdf from
  464. pdfDownloadDomain: process.env.PDF_DOWNLOAD_DOMAIN, // "http://clsi-lb:3014"
  465. // By default turn on feature flag, can be overridden per request.
  466. enablePdfCaching: process.env.ENABLE_PDF_CACHING === 'true',
  467. // Whether to disable any existing service worker on the next load of the editor
  468. resetServiceWorker: process.env.RESET_SERVICE_WORKER === 'true',
  469. // Maximum size of text documents in the real-time editing system.
  470. max_doc_length: 2 * 1024 * 1024, // 2mb
  471. primary_email_check_expiration: 1000 * 60 * 60 * 24 * 90, // 90 days
  472. // Maximum JSON size in HTTP requests
  473. // We should be able to process twice the max doc length, to allow for
  474. // - the doc content
  475. // - text ranges spanning the whole doc
  476. //
  477. // There's also overhead required for the JSON encoding and the UTF-8 encoding,
  478. // theoretically up to 3 times the max doc length. On the other hand, we don't
  479. // want to block the event loop with JSON parsing, so we try to find a
  480. // practical compromise.
  481. max_json_request_size:
  482. parseInt(process.env.MAX_JSON_REQUEST_SIZE) || 6 * 1024 * 1024, // 6 MB
  483. // Internal configs
  484. // ----------------
  485. path: {
  486. // If we ever need to write something to disk (e.g. incoming requests
  487. // that need processing but may be too big for memory, then write
  488. // them to disk here).
  489. dumpFolder: './data/dumpFolder',
  490. uploadFolder: './data/uploads',
  491. },
  492. // Automatic Snapshots
  493. // -------------------
  494. automaticSnapshots: {
  495. // How long should we wait after the user last edited to
  496. // take a snapshot?
  497. waitTimeAfterLastEdit: 5 * minutes,
  498. // Even if edits are still taking place, this is maximum
  499. // time to wait before taking another snapshot.
  500. maxTimeBetweenSnapshots: 30 * minutes,
  501. },
  502. // Smoke test
  503. // ----------
  504. // Provide log in credentials and a project to be able to run
  505. // some basic smoke tests to check the core functionality.
  506. //
  507. smokeTest: {
  508. user: process.env.SMOKE_TEST_USER,
  509. userId: process.env.SMOKE_TEST_USER_ID,
  510. password: process.env.SMOKE_TEST_PASSWORD,
  511. projectId: process.env.SMOKE_TEST_PROJECT_ID,
  512. rateLimitSubject: process.env.SMOKE_TEST_RATE_LIMIT_SUBJECT || '127.0.0.1',
  513. stepTimeout: parseInt(process.env.SMOKE_TEST_STEP_TIMEOUT || '10000', 10),
  514. },
  515. appName: process.env.APP_NAME || 'ShareLaTeX (Community Edition)',
  516. adminEmail: process.env.ADMIN_EMAIL || 'placeholder@example.com',
  517. adminDomains: process.env.ADMIN_DOMAINS
  518. ? JSON.parse(process.env.ADMIN_DOMAINS)
  519. : undefined,
  520. nav: {
  521. title: 'ShareLaTeX Community Edition',
  522. hide_powered_by: process.env.NAV_HIDE_POWERED_BY === 'true',
  523. left_footer: [],
  524. right_footer: [
  525. {
  526. text: "<i class='fa fa-github-square'></i> Fork on GitHub!",
  527. url: 'https://github.com/overleaf/overleaf',
  528. },
  529. ],
  530. showSubscriptionLink: false,
  531. header_extras: [],
  532. },
  533. // Example:
  534. // header_extras: [{text: "Some Page", url: "http://example.com/some/page", class: "subdued"}]
  535. recaptcha: {
  536. endpoint:
  537. process.env.RECAPTCHA_ENDPOINT ||
  538. 'https://www.google.com/recaptcha/api/siteverify',
  539. disabled: {
  540. invite: true,
  541. login: true,
  542. passwordReset: true,
  543. register: true,
  544. },
  545. },
  546. customisation: {},
  547. redirects: {
  548. '/templates/index': '/templates/',
  549. },
  550. reloadModuleViewsOnEachRequest: process.env.NODE_ENV === 'development',
  551. rateLimit: {
  552. autoCompile: {
  553. everyone: process.env.RATE_LIMIT_AUTO_COMPILE_EVERYONE || 100,
  554. standard: process.env.RATE_LIMIT_AUTO_COMPILE_STANDARD || 25,
  555. },
  556. },
  557. analytics: {
  558. enabled: false,
  559. },
  560. compileBodySizeLimitMb: process.env.COMPILE_BODY_SIZE_LIMIT_MB || 5,
  561. textExtensions: defaultTextExtensions.concat(
  562. parseTextExtensions(process.env.ADDITIONAL_TEXT_EXTENSIONS)
  563. ),
  564. validRootDocExtensions: ['tex', 'Rtex', 'ltx'],
  565. emailConfirmationDisabled:
  566. process.env.EMAIL_CONFIRMATION_DISABLED === 'true' || false,
  567. enabledServices: (process.env.ENABLED_SERVICES || 'web,api')
  568. .split(',')
  569. .map(s => s.trim()),
  570. // module options
  571. // ----------
  572. modules: {
  573. sanitize: {
  574. options: {
  575. allowedTags: [
  576. 'h1',
  577. 'h2',
  578. 'h3',
  579. 'h4',
  580. 'h5',
  581. 'h6',
  582. 'blockquote',
  583. 'p',
  584. 'a',
  585. 'ul',
  586. 'ol',
  587. 'nl',
  588. 'li',
  589. 'b',
  590. 'i',
  591. 'strong',
  592. 'em',
  593. 'strike',
  594. 'code',
  595. 'hr',
  596. 'br',
  597. 'div',
  598. 'table',
  599. 'thead',
  600. 'col',
  601. 'caption',
  602. 'tbody',
  603. 'tr',
  604. 'th',
  605. 'td',
  606. 'tfoot',
  607. 'pre',
  608. 'iframe',
  609. 'img',
  610. 'figure',
  611. 'figcaption',
  612. 'span',
  613. 'source',
  614. 'video',
  615. 'del',
  616. ],
  617. allowedAttributes: {
  618. a: [
  619. 'href',
  620. 'name',
  621. 'target',
  622. 'class',
  623. 'event-tracking',
  624. 'event-tracking-ga',
  625. 'event-tracking-label',
  626. 'event-tracking-trigger',
  627. ],
  628. div: ['class', 'id', 'style'],
  629. h1: ['class', 'id'],
  630. h2: ['class', 'id'],
  631. h3: ['class', 'id'],
  632. h4: ['class', 'id'],
  633. h5: ['class', 'id'],
  634. h6: ['class', 'id'],
  635. col: ['width'],
  636. figure: ['class', 'id', 'style'],
  637. figcaption: ['class', 'id', 'style'],
  638. i: ['aria-hidden', 'aria-label', 'class', 'id'],
  639. iframe: [
  640. 'allowfullscreen',
  641. 'frameborder',
  642. 'height',
  643. 'src',
  644. 'style',
  645. 'width',
  646. ],
  647. img: ['alt', 'class', 'src', 'style'],
  648. source: ['src', 'type'],
  649. span: ['class', 'id', 'style'],
  650. strong: ['style'],
  651. table: ['border', 'class', 'id', 'style'],
  652. td: ['colspan', 'rowspan', 'headers', 'style'],
  653. th: [
  654. 'abbr',
  655. 'headers',
  656. 'colspan',
  657. 'rowspan',
  658. 'scope',
  659. 'sorted',
  660. 'style',
  661. ],
  662. tr: ['class'],
  663. video: ['alt', 'class', 'controls', 'height', 'width'],
  664. },
  665. },
  666. },
  667. },
  668. overleafModuleImports: {
  669. // modules to import (an empty array for each set of modules)
  670. createFileModes: [],
  671. gitBridge: [],
  672. publishModal: [],
  673. tprLinkedFileInfo: [],
  674. tprLinkedFileRefreshError: [],
  675. contactUsModal: [],
  676. editorToolbarButtons: [],
  677. sourceEditorExtensions: [],
  678. sourceEditorComponents: [],
  679. },
  680. moduleImportSequence: ['launchpad', 'server-ce-scripts', 'user-activate'],
  681. csp: {
  682. enabled: process.env.CSP_ENABLED === 'true',
  683. reportOnly: process.env.CSP_REPORT_ONLY === 'true',
  684. reportPercentage: parseFloat(process.env.CSP_REPORT_PERCENTAGE) || 0,
  685. reportUri: process.env.CSP_REPORT_URI,
  686. exclude: ['app/views/project/editor', 'app/views/project/list'],
  687. },
  688. unsupportedBrowsers: {
  689. ie: '<=11',
  690. },
  691. }
  692. module.exports.mergeWith = function (overrides) {
  693. return merge(overrides, module.exports)
  694. }