settings.defaults.js 23 KB

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