settings.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785
  1. /* eslint-disable
  2. camelcase,
  3. no-cond-assign,
  4. no-dupe-keys,
  5. no-unused-vars,
  6. */
  7. // TODO: This file was created by bulk-decaffeinate.
  8. // Fix any style issues and re-enable lint.
  9. /*
  10. * decaffeinate suggestions:
  11. * DS205: Consider reworking code to avoid use of IIFEs
  12. * DS207: Consider shorter variations of null checks
  13. * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
  14. */
  15. let redisConfig, siteUrl
  16. let e
  17. const Path = require('path')
  18. // These credentials are used for authenticating api requests
  19. // between services that may need to go over public channels
  20. const httpAuthUser = 'sharelatex'
  21. const httpAuthPass = process.env.WEB_API_PASSWORD
  22. const httpAuthUsers = {}
  23. httpAuthUsers[httpAuthUser] = httpAuthPass
  24. const parse = function (option) {
  25. if (option != null) {
  26. try {
  27. const opt = JSON.parse(option)
  28. return opt
  29. } catch (err) {
  30. throw new Error(`problem parsing ${option}, invalid JSON`)
  31. }
  32. }
  33. }
  34. const parseIntOrFail = function (value) {
  35. const parsedValue = parseInt(value, 10)
  36. if (isNaN(parsedValue)) {
  37. throw new Error(`'${value}' is an invalid integer`)
  38. }
  39. return parsedValue
  40. }
  41. const DATA_DIR = '/var/lib/sharelatex/data'
  42. const TMP_DIR = '/var/lib/sharelatex/tmp'
  43. const settings = {
  44. clsi: {
  45. optimiseInDocker: process.env.OPTIMISE_PDF === 'true',
  46. },
  47. brandPrefix: '',
  48. allowAnonymousReadAndWriteSharing:
  49. process.env.SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING === 'true',
  50. // Databases
  51. // ---------
  52. // ShareLaTeX's main persistent data store is MongoDB (http://www.mongodb.org/)
  53. // Documentation about the URL connection string format can be found at:
  54. //
  55. // http://docs.mongodb.org/manual/reference/connection-string/
  56. //
  57. // The following works out of the box with Mongo's default settings:
  58. mongo: {
  59. url: process.env.SHARELATEX_MONGO_URL || 'mongodb://dockerhost/sharelatex',
  60. },
  61. // Redis is used in ShareLaTeX for high volume queries, like real-time
  62. // editing, and session management.
  63. //
  64. // The following config will work with Redis's default settings:
  65. redis: {
  66. web: (redisConfig = {
  67. host: process.env.SHARELATEX_REDIS_HOST || 'dockerhost',
  68. port: process.env.SHARELATEX_REDIS_PORT || '6379',
  69. password: process.env.SHARELATEX_REDIS_PASS || undefined,
  70. key_schema: {
  71. // document-updater
  72. blockingKey({ doc_id }) {
  73. return `Blocking:${doc_id}`
  74. },
  75. docLines({ doc_id }) {
  76. return `doclines:${doc_id}`
  77. },
  78. docOps({ doc_id }) {
  79. return `DocOps:${doc_id}`
  80. },
  81. docVersion({ doc_id }) {
  82. return `DocVersion:${doc_id}`
  83. },
  84. docHash({ doc_id }) {
  85. return `DocHash:${doc_id}`
  86. },
  87. projectKey({ doc_id }) {
  88. return `ProjectId:${doc_id}`
  89. },
  90. docsInProject({ project_id }) {
  91. return `DocsIn:${project_id}`
  92. },
  93. ranges({ doc_id }) {
  94. return `Ranges:${doc_id}`
  95. },
  96. // document-updater:realtime
  97. pendingUpdates({ doc_id }) {
  98. return `PendingUpdates:${doc_id}`
  99. },
  100. // document-updater:history
  101. uncompressedHistoryOps({ doc_id }) {
  102. return `UncompressedHistoryOps:${doc_id}`
  103. },
  104. docsWithHistoryOps({ project_id }) {
  105. return `DocsWithHistoryOps:${project_id}`
  106. },
  107. // document-updater:lock
  108. blockingKey({ doc_id }) {
  109. return `Blocking:${doc_id}`
  110. },
  111. // track-changes:lock
  112. historyLock({ doc_id }) {
  113. return `HistoryLock:${doc_id}`
  114. },
  115. historyIndexLock({ project_id }) {
  116. return `HistoryIndexLock:${project_id}`
  117. },
  118. // track-changes:history
  119. uncompressedHistoryOps({ doc_id }) {
  120. return `UncompressedHistoryOps:${doc_id}`
  121. },
  122. docsWithHistoryOps({ project_id }) {
  123. return `DocsWithHistoryOps:${project_id}`
  124. },
  125. // realtime
  126. clientsInProject({ project_id }) {
  127. return `clients_in_project:${project_id}`
  128. },
  129. connectedUser({ project_id, client_id }) {
  130. return `connected_user:${project_id}:${client_id}`
  131. },
  132. },
  133. }),
  134. fairy: redisConfig,
  135. // track-changes and document-updater
  136. realtime: redisConfig,
  137. documentupdater: redisConfig,
  138. lock: redisConfig,
  139. history: redisConfig,
  140. websessions: redisConfig,
  141. api: redisConfig,
  142. pubsub: redisConfig,
  143. project_history: redisConfig,
  144. project_history_migration: {
  145. host: redisConfig.host,
  146. port: redisConfig.port,
  147. password: redisConfig.password,
  148. maxRetriesPerRequest: parseInt(
  149. process.env.REDIS_MAX_RETRIES_PER_REQUEST || '20'
  150. ),
  151. key_schema: {
  152. projectHistoryOps({ projectId }) {
  153. return `ProjectHistory:Ops:{${projectId}}` // NOTE: the extra braces are intentional
  154. },
  155. },
  156. },
  157. },
  158. trackchanges: {
  159. continueOnError: true,
  160. },
  161. // Local disk caching
  162. // ------------------
  163. path: {
  164. // If we ever need to write something to disk (e.g. incoming requests
  165. // that need processing but may be too big for memory), then write
  166. // them to disk here:
  167. dumpFolder: Path.join(TMP_DIR, 'dumpFolder'),
  168. // Where to write uploads before they are processed
  169. uploadFolder: Path.join(TMP_DIR, 'uploads'),
  170. // Where to write intermediate file for full project history migration
  171. projectHistories: Path.join(TMP_DIR, 'projectHistories'),
  172. // Where to write the project to disk before running LaTeX on it
  173. compilesDir: Path.join(DATA_DIR, 'compiles'),
  174. // Where to cache downloaded URLs for the CLSI
  175. clsiCacheDir: Path.join(DATA_DIR, 'cache'),
  176. // Where to write the output files to disk after running LaTeX
  177. outputDir: Path.join(DATA_DIR, 'output'),
  178. },
  179. // Server Config
  180. // -------------
  181. // Where your instance of ShareLaTeX can be found publicly. This is used
  182. // when emails are sent out and in generated links:
  183. siteUrl: (siteUrl = process.env.SHARELATEX_SITE_URL || 'http://localhost'),
  184. // Status page URL as displayed on the maintenance/500 pages.
  185. statusPageUrl: process.env.SHARELATEX_STATUS_PAGE_URL,
  186. // The name this is used to describe your ShareLaTeX Installation
  187. appName: process.env.SHARELATEX_APP_NAME || 'ShareLaTeX (Community Edition)',
  188. restrictInvitesToExistingAccounts:
  189. process.env.SHARELATEX_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS === 'true',
  190. nav: {
  191. title:
  192. process.env.SHARELATEX_NAV_TITLE ||
  193. process.env.SHARELATEX_APP_NAME ||
  194. 'ShareLaTeX Community Edition',
  195. },
  196. // The email address which users will be directed to as the main point of
  197. // contact for this installation of ShareLaTeX.
  198. adminEmail: process.env.SHARELATEX_ADMIN_EMAIL || 'placeholder@example.com',
  199. // If provided, a sessionSecret is used to sign cookies so that they cannot be
  200. // spoofed. This is recommended.
  201. security: {
  202. sessionSecret:
  203. process.env.SHARELATEX_SESSION_SECRET || process.env.CRYPTO_RANDOM,
  204. },
  205. // These credentials are used for authenticating api requests
  206. // between services that may need to go over public channels
  207. httpAuthUsers,
  208. // Should javascript assets be served minified or not.
  209. useMinifiedJs: true,
  210. // Should static assets be sent with a header to tell the browser to cache
  211. // them. This should be false in development where changes are being made,
  212. // but should be set to true in production.
  213. cacheStaticAssets: true,
  214. // If you are running ShareLaTeX over https, set this to true to send the
  215. // cookie with a secure flag (recommended).
  216. secureCookie: process.env.SHARELATEX_SECURE_COOKIE != null,
  217. // If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  218. // then set this to true to allow it to correctly detect the forwarded IP
  219. // address and http/https protocol information.
  220. behindProxy: process.env.SHARELATEX_BEHIND_PROXY || false,
  221. i18n: {
  222. subdomainLang: {
  223. www: {
  224. lngCode: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  225. url: siteUrl,
  226. },
  227. },
  228. defaultLng: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  229. },
  230. currentImageName: process.env.TEX_LIVE_DOCKER_IMAGE,
  231. apis: {
  232. web: {
  233. url: 'http://localhost:3000',
  234. user: httpAuthUser,
  235. pass: httpAuthPass,
  236. },
  237. project_history: {
  238. sendProjectStructureOps: true,
  239. initializeHistoryForNewProjects: process.env.SHARELATEX_FPH_INITIALIZE_NEW_PROJECTS === 'true',
  240. displayHistoryForNewProjects: process.env.SHARELATEX_FPH_DISPLAY_NEW_PROJECTS === 'true',
  241. url: 'http://localhost:3054',
  242. },
  243. v1_history: {
  244. url: 'http://localhost:3100/api',
  245. user: 'staging',
  246. pass: process.env.STAGING_PASSWORD,
  247. },
  248. },
  249. references: {},
  250. notifications: undefined,
  251. defaultFeatures: {
  252. collaborators: -1,
  253. dropbox: true,
  254. versioning: true,
  255. compileTimeout: parseIntOrFail(process.env.COMPILE_TIMEOUT || 180),
  256. compileGroup: 'standard',
  257. trackChanges: true,
  258. templates: true,
  259. references: true,
  260. },
  261. }
  262. // # OPTIONAL CONFIGURABLE SETTINGS
  263. if (process.env.SHARELATEX_LEFT_FOOTER != null) {
  264. try {
  265. settings.nav.left_footer = JSON.parse(process.env.SHARELATEX_LEFT_FOOTER)
  266. } catch (error) {
  267. e = error
  268. console.error('could not parse SHARELATEX_LEFT_FOOTER, not valid JSON')
  269. }
  270. }
  271. if (process.env.SHARELATEX_RIGHT_FOOTER != null) {
  272. settings.nav.right_footer = process.env.SHARELATEX_RIGHT_FOOTER
  273. try {
  274. settings.nav.right_footer = JSON.parse(process.env.SHARELATEX_RIGHT_FOOTER)
  275. } catch (error1) {
  276. e = error1
  277. console.error('could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON')
  278. }
  279. }
  280. if (process.env.SHARELATEX_HEADER_IMAGE_URL != null) {
  281. settings.nav.custom_logo = process.env.SHARELATEX_HEADER_IMAGE_URL
  282. }
  283. if (process.env.SHARELATEX_HEADER_NAV_LINKS != null) {
  284. console.error(`\
  285. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  286. #
  287. # WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported
  288. # See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo
  289. #
  290. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  291. `)
  292. }
  293. if (process.env.SHARELATEX_HEADER_EXTRAS != null) {
  294. try {
  295. settings.nav.header_extras = JSON.parse(
  296. process.env.SHARELATEX_HEADER_EXTRAS
  297. )
  298. } catch (error2) {
  299. e = error2
  300. console.error('could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON')
  301. }
  302. }
  303. // Sending Email
  304. // -------------
  305. //
  306. // You must configure a mail server to be able to send invite emails from
  307. // ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer
  308. // documentation for available options:
  309. //
  310. // http://www.nodemailer.com/docs/transports
  311. if (process.env.SHARELATEX_EMAIL_FROM_ADDRESS != null) {
  312. settings.email = {
  313. fromAddress: process.env.SHARELATEX_EMAIL_FROM_ADDRESS,
  314. replyTo: process.env.SHARELATEX_EMAIL_REPLY_TO || '',
  315. driver: process.env.SHARELATEX_EMAIL_DRIVER,
  316. parameters: {
  317. // AWS Creds
  318. AWSAccessKeyID: process.env.SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID,
  319. AWSSecretKey: process.env.SHARELATEX_EMAIL_AWS_SES_SECRET_KEY,
  320. // SMTP Creds
  321. host: process.env.SHARELATEX_EMAIL_SMTP_HOST,
  322. port: process.env.SHARELATEX_EMAIL_SMTP_PORT,
  323. secure: parse(process.env.SHARELATEX_EMAIL_SMTP_SECURE),
  324. ignoreTLS: parse(process.env.SHARELATEX_EMAIL_SMTP_IGNORE_TLS),
  325. name: process.env.SHARELATEX_EMAIL_SMTP_NAME,
  326. logger: process.env.SHARELATEX_EMAIL_SMTP_LOGGER === 'true',
  327. },
  328. textEncoding: process.env.SHARELATEX_EMAIL_TEXT_ENCODING,
  329. template: {
  330. customFooter: process.env.SHARELATEX_CUSTOM_EMAIL_FOOTER,
  331. },
  332. }
  333. if (process.env.SHARELATEX_EMAIL_AWS_SES_REGION != null) {
  334. settings.email.parameters.region =
  335. process.env.SHARELATEX_EMAIL_AWS_SES_REGION
  336. }
  337. if (
  338. process.env.SHARELATEX_EMAIL_SMTP_USER != null ||
  339. process.env.SHARELATEX_EMAIL_SMTP_PASS != null
  340. ) {
  341. settings.email.parameters.auth = {
  342. user: process.env.SHARELATEX_EMAIL_SMTP_USER,
  343. pass: process.env.SHARELATEX_EMAIL_SMTP_PASS,
  344. }
  345. }
  346. if (process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH != null) {
  347. settings.email.parameters.tls = {
  348. rejectUnauthorized: parse(
  349. process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH
  350. ),
  351. }
  352. }
  353. }
  354. // i18n
  355. if (process.env.SHARELATEX_LANG_DOMAIN_MAPPING != null) {
  356. settings.i18n.subdomainLang = parse(
  357. process.env.SHARELATEX_LANG_DOMAIN_MAPPING
  358. )
  359. }
  360. // Password Settings
  361. // -----------
  362. // These restrict the passwords users can use when registering
  363. // opts are from http://antelle.github.io/passfield
  364. if (
  365. process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN ||
  366. process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH ||
  367. process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH
  368. ) {
  369. settings.passwordStrengthOptions = {
  370. pattern: process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN || 'aA$3',
  371. length: {
  372. min: process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH || 8,
  373. max: process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH || 150,
  374. },
  375. }
  376. }
  377. // ######################
  378. // ShareLaTeX Server Pro
  379. // ######################
  380. if (parse(process.env.SHARELATEX_IS_SERVER_PRO) === true) {
  381. settings.bypassPercentageRollouts = true
  382. settings.apis.references = { url: 'http://localhost:3040' }
  383. }
  384. // LDAP - SERVER PRO ONLY
  385. // ----------
  386. if (process.env.SHARELATEX_LDAP_HOST) {
  387. console.error(`\
  388. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  389. #
  390. # WARNING: The LDAP configuration format has changed in version 0.5.1
  391. # See https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-LDAP-Config
  392. #
  393. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  394. `)
  395. }
  396. if (process.env.SHARELATEX_LDAP_URL) {
  397. let _ldap_connect_timeout,
  398. _ldap_group_search_attribs,
  399. _ldap_search_attribs,
  400. _ldap_timeout
  401. settings.externalAuth = true
  402. settings.ldap = {
  403. emailAtt: process.env.SHARELATEX_LDAP_EMAIL_ATT,
  404. nameAtt: process.env.SHARELATEX_LDAP_NAME_ATT,
  405. lastNameAtt: process.env.SHARELATEX_LDAP_LAST_NAME_ATT,
  406. updateUserDetailsOnLogin:
  407. process.env.SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  408. placeholder: process.env.SHARELATEX_LDAP_PLACEHOLDER,
  409. server: {
  410. url: process.env.SHARELATEX_LDAP_URL,
  411. bindDn: process.env.SHARELATEX_LDAP_BIND_DN,
  412. bindCredentials: process.env.SHARELATEX_LDAP_BIND_CREDENTIALS,
  413. bindProperty: process.env.SHARELATEX_LDAP_BIND_PROPERTY,
  414. searchBase: process.env.SHARELATEX_LDAP_SEARCH_BASE,
  415. searchScope: process.env.SHARELATEX_LDAP_SEARCH_SCOPE,
  416. searchFilter: process.env.SHARELATEX_LDAP_SEARCH_FILTER,
  417. searchAttributes: (_ldap_search_attribs =
  418. process.env.SHARELATEX_LDAP_SEARCH_ATTRIBUTES)
  419. ? (() => {
  420. try {
  421. return JSON.parse(_ldap_search_attribs)
  422. } catch (error3) {
  423. e = error3
  424. return console.error(
  425. 'could not parse SHARELATEX_LDAP_SEARCH_ATTRIBUTES'
  426. )
  427. }
  428. })()
  429. : undefined,
  430. groupDnProperty: process.env.SHARELATEX_LDAP_GROUP_DN_PROPERTY,
  431. groupSearchBase: process.env.SHARELATEX_LDAP_GROUP_SEARCH_BASE,
  432. groupSearchScope: process.env.SHARELATEX_LDAP_GROUP_SEARCH_SCOPE,
  433. groupSearchFilter: process.env.SHARELATEX_LDAP_GROUP_SEARCH_FILTER,
  434. groupSearchAttributes: (_ldap_group_search_attribs =
  435. process.env.SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES)
  436. ? (() => {
  437. try {
  438. return JSON.parse(_ldap_group_search_attribs)
  439. } catch (error4) {
  440. e = error4
  441. return console.error(
  442. 'could not parse SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES'
  443. )
  444. }
  445. })()
  446. : undefined,
  447. cache: process.env.SHARELATEX_LDAP_CACHE === 'true',
  448. timeout: (_ldap_timeout = process.env.SHARELATEX_LDAP_TIMEOUT)
  449. ? (() => {
  450. try {
  451. return parseIntOrFail(_ldap_timeout)
  452. } catch (error5) {
  453. e = error5
  454. return console.error('Cannot parse SHARELATEX_LDAP_TIMEOUT')
  455. }
  456. })()
  457. : undefined,
  458. connectTimeout: (_ldap_connect_timeout =
  459. process.env.SHARELATEX_LDAP_CONNECT_TIMEOUT)
  460. ? (() => {
  461. try {
  462. return parseIntOrFail(_ldap_connect_timeout)
  463. } catch (error6) {
  464. e = error6
  465. return console.error(
  466. 'Cannot parse SHARELATEX_LDAP_CONNECT_TIMEOUT'
  467. )
  468. }
  469. })()
  470. : undefined,
  471. },
  472. }
  473. if (process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH) {
  474. let ca, ca_paths
  475. try {
  476. ca = JSON.parse(process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH)
  477. } catch (error7) {
  478. e = error7
  479. console.error(
  480. 'could not parse SHARELATEX_LDAP_TLS_OPTS_CA_PATH, invalid JSON'
  481. )
  482. }
  483. if (typeof ca === 'string') {
  484. ca_paths = [ca]
  485. } else if (
  486. typeof ca === 'object' &&
  487. (ca != null ? ca.length : undefined) != null
  488. ) {
  489. ca_paths = ca
  490. } else {
  491. console.error('problem parsing SHARELATEX_LDAP_TLS_OPTS_CA_PATH')
  492. }
  493. settings.ldap.server.tlsOptions = {
  494. rejectUnauthorized:
  495. process.env.SHARELATEX_LDAP_TLS_OPTS_REJECT_UNAUTH === 'true',
  496. ca: ca_paths, // e.g.'/etc/ldap/ca_certs.pem'
  497. }
  498. }
  499. }
  500. if (process.env.SHARELATEX_SAML_ENTRYPOINT) {
  501. // NOTE: see https://github.com/node-saml/passport-saml/blob/master/README.md for docs of `server` options
  502. let _saml_additionalAuthorizeParams,
  503. _saml_additionalLogoutParams,
  504. _saml_additionalParams,
  505. _saml_expiration,
  506. _saml_skew
  507. settings.externalAuth = true
  508. settings.saml = {
  509. updateUserDetailsOnLogin:
  510. process.env.SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  511. identityServiceName: process.env.SHARELATEX_SAML_IDENTITY_SERVICE_NAME,
  512. emailField:
  513. process.env.SHARELATEX_SAML_EMAIL_FIELD ||
  514. process.env.SHARELATEX_SAML_EMAIL_FIELD_NAME,
  515. firstNameField: process.env.SHARELATEX_SAML_FIRST_NAME_FIELD,
  516. lastNameField: process.env.SHARELATEX_SAML_LAST_NAME_FIELD,
  517. server: {
  518. // strings
  519. entryPoint: process.env.SHARELATEX_SAML_ENTRYPOINT,
  520. callbackUrl: process.env.SHARELATEX_SAML_CALLBACK_URL,
  521. issuer: process.env.SHARELATEX_SAML_ISSUER,
  522. decryptionPvk: process.env.SHARELATEX_SAML_DECRYPTION_PVK,
  523. decryptionCert: process.env.SHARELATEX_SAML_DECRYPTION_CERT,
  524. signingCert: process.env.SHARELATEX_SAML_SIGNING_CERT,
  525. signatureAlgorithm: process.env.SHARELATEX_SAML_SIGNATURE_ALGORITHM,
  526. identifierFormat: process.env.SHARELATEX_SAML_IDENTIFIER_FORMAT,
  527. attributeConsumingServiceIndex:
  528. process.env.SHARELATEX_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX,
  529. authnContext:
  530. process.env.SHARELATEX_SAML_AUTHN_CONTEXT &&
  531. process.env.SHARELATEX_SAML_AUTHN_CONTEXT.split(','),
  532. authnRequestBinding: process.env.SHARELATEX_SAML_AUTHN_REQUEST_BINDING,
  533. validateInResponseTo: process.env.SHARELATEX_SAML_VALIDATE_IN_RESPONSE_TO,
  534. cacheProvider: process.env.SHARELATEX_SAML_CACHE_PROVIDER,
  535. logoutUrl: process.env.SHARELATEX_SAML_LOGOUT_URL,
  536. logoutCallbackUrl: process.env.SHARELATEX_SAML_LOGOUT_CALLBACK_URL,
  537. disableRequestedAuthnContext:
  538. process.env.SHARELATEX_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT === 'true',
  539. forceAuthn: process.env.SHARELATEX_SAML_FORCE_AUTHN === 'true',
  540. skipRequestCompression:
  541. process.env.SHARELATEX_SAML_SKIP_REQUEST_COMPRESSION === 'true',
  542. acceptedClockSkewMs: (_saml_skew =
  543. process.env.SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS)
  544. ? (() => {
  545. try {
  546. return parseIntOrFail(_saml_skew)
  547. } catch (error8) {
  548. e = error8
  549. return console.error(
  550. 'Cannot parse SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS'
  551. )
  552. }
  553. })()
  554. : undefined,
  555. requestIdExpirationPeriodMs: (_saml_expiration =
  556. process.env.SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS)
  557. ? (() => {
  558. try {
  559. return parseIntOrFail(_saml_expiration)
  560. } catch (error9) {
  561. e = error9
  562. return console.error(
  563. 'Cannot parse SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS'
  564. )
  565. }
  566. })()
  567. : undefined,
  568. additionalParams: (_saml_additionalParams =
  569. process.env.SHARELATEX_SAML_ADDITIONAL_PARAMS)
  570. ? (() => {
  571. try {
  572. return JSON.parse(_saml_additionalParams)
  573. } catch (error10) {
  574. e = error10
  575. return console.error(
  576. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_PARAMS'
  577. )
  578. }
  579. })()
  580. : undefined,
  581. additionalAuthorizeParams: (_saml_additionalAuthorizeParams =
  582. process.env.SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS)
  583. ? (() => {
  584. try {
  585. return JSON.parse(_saml_additionalAuthorizeParams)
  586. } catch (error11) {
  587. e = error11
  588. return console.error(
  589. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS'
  590. )
  591. }
  592. })()
  593. : undefined,
  594. additionalLogoutParams: (_saml_additionalLogoutParams =
  595. process.env.SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS)
  596. ? (() => {
  597. try {
  598. return JSON.parse(_saml_additionalLogoutParams)
  599. } catch (error12) {
  600. e = error12
  601. return console.error(
  602. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS'
  603. )
  604. }
  605. })()
  606. : undefined,
  607. },
  608. }
  609. // SHARELATEX_SAML_CERT cannot be empty
  610. // https://github.com/node-saml/passport-saml/commit/f6b1c885c0717f1083c664345556b535f217c102
  611. if (process.env.SHARELATEX_SAML_CERT) {
  612. settings.saml.server.cert = process.env.SHARELATEX_SAML_CERT
  613. settings.saml.server.privateKey = process.env.SHARELATEX_SAML_PRIVATE_CERT
  614. }
  615. }
  616. // Compiler
  617. // --------
  618. if (process.env.SANDBOXED_COMPILES === 'true') {
  619. settings.clsi = {
  620. dockerRunner: true,
  621. docker: {
  622. image: process.env.TEX_LIVE_DOCKER_IMAGE,
  623. env: {
  624. HOME: '/tmp',
  625. PATH:
  626. process.env.COMPILER_PATH ||
  627. '/usr/local/texlive/2015/bin/x86_64-linux:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin',
  628. },
  629. user: 'www-data',
  630. },
  631. }
  632. if (settings.path == null) {
  633. settings.path = {}
  634. }
  635. settings.path.synctexBaseDir = () => '/compile'
  636. if (process.env.SANDBOXED_COMPILES_SIBLING_CONTAINERS === 'true') {
  637. console.log('Using sibling containers for sandboxed compiles')
  638. if (process.env.SANDBOXED_COMPILES_HOST_DIR) {
  639. settings.path.sandboxedCompilesHostDir =
  640. process.env.SANDBOXED_COMPILES_HOST_DIR
  641. } else {
  642. console.error(
  643. 'Sibling containers, but SANDBOXED_COMPILES_HOST_DIR not set'
  644. )
  645. }
  646. }
  647. }
  648. // Templates
  649. // ---------
  650. if (process.env.SHARELATEX_TEMPLATES_USER_ID) {
  651. settings.templates = {
  652. mountPointUrl: '/templates',
  653. user_id: process.env.SHARELATEX_TEMPLATES_USER_ID,
  654. }
  655. settings.templateLinks = parse(
  656. process.env.SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS
  657. )
  658. }
  659. // /Learn
  660. // -------
  661. if (process.env.SHARELATEX_PROXY_LEARN != null) {
  662. settings.proxyLearn = parse(process.env.SHARELATEX_PROXY_LEARN)
  663. if (settings.proxyLearn) {
  664. settings.nav.header_extras = [
  665. {
  666. url: '/learn',
  667. text: 'documentation',
  668. },
  669. ].concat(settings.nav.header_extras || [])
  670. }
  671. }
  672. // /References
  673. // -----------
  674. if (process.env.SHARELATEX_ELASTICSEARCH_URL != null) {
  675. settings.references.elasticsearch = {
  676. host: process.env.SHARELATEX_ELASTICSEARCH_URL,
  677. }
  678. }
  679. // filestore
  680. switch (process.env.SHARELATEX_FILESTORE_BACKEND) {
  681. case 's3':
  682. settings.filestore = {
  683. backend: 's3',
  684. stores: {
  685. user_files: process.env.SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME,
  686. template_files:
  687. process.env.SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME,
  688. },
  689. s3: {
  690. key:
  691. process.env.SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID ||
  692. process.env.AWS_ACCESS_KEY_ID,
  693. secret:
  694. process.env.SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY ||
  695. process.env.AWS_SECRET_ACCESS_KEY,
  696. endpoint: process.env.SHARELATEX_FILESTORE_S3_ENDPOINT,
  697. pathStyle: process.env.SHARELATEX_FILESTORE_S3_PATH_STYLE === 'true',
  698. region:
  699. process.env.SHARELATEX_FILESTORE_S3_REGION ||
  700. process.env.AWS_DEFAULT_REGION,
  701. },
  702. }
  703. break
  704. default:
  705. settings.filestore = {
  706. backend: 'fs',
  707. stores: {
  708. user_files: Path.join(DATA_DIR, 'user_files'),
  709. template_files: Path.join(DATA_DIR, 'template_files'),
  710. },
  711. }
  712. }
  713. // With lots of incoming and outgoing HTTP connections to different services,
  714. // sometimes long running, it is a good idea to increase the default number
  715. // of sockets that Node will hold open.
  716. const http = require('http')
  717. http.globalAgent.maxSockets = 300
  718. const https = require('https')
  719. https.globalAgent.maxSockets = 300
  720. module.exports = settings