settings.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786
  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. trustedProxyIps: process.env.SHARELATEX_TRUSTED_PROXY_IPS,
  222. i18n: {
  223. subdomainLang: {
  224. www: {
  225. lngCode: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  226. url: siteUrl,
  227. },
  228. },
  229. defaultLng: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  230. },
  231. currentImageName: process.env.TEX_LIVE_DOCKER_IMAGE,
  232. apis: {
  233. web: {
  234. url: 'http://localhost:3000',
  235. user: httpAuthUser,
  236. pass: httpAuthPass,
  237. },
  238. project_history: {
  239. sendProjectStructureOps: true,
  240. initializeHistoryForNewProjects: process.env.SHARELATEX_FPH_INITIALIZE_NEW_PROJECTS === 'true',
  241. displayHistoryForNewProjects: process.env.SHARELATEX_FPH_DISPLAY_NEW_PROJECTS === 'true',
  242. url: 'http://localhost:3054',
  243. },
  244. v1_history: {
  245. url: process.env.V1_HISTORY_URL || 'http://localhost:3100/api',
  246. user: 'staging',
  247. pass: process.env.STAGING_PASSWORD,
  248. },
  249. },
  250. references: {},
  251. notifications: undefined,
  252. defaultFeatures: {
  253. collaborators: -1,
  254. dropbox: true,
  255. versioning: true,
  256. compileTimeout: parseIntOrFail(process.env.COMPILE_TIMEOUT || 180),
  257. compileGroup: 'standard',
  258. trackChanges: true,
  259. templates: true,
  260. references: true,
  261. },
  262. }
  263. // # OPTIONAL CONFIGURABLE SETTINGS
  264. if (process.env.SHARELATEX_LEFT_FOOTER != null) {
  265. try {
  266. settings.nav.left_footer = JSON.parse(process.env.SHARELATEX_LEFT_FOOTER)
  267. } catch (error) {
  268. e = error
  269. console.error('could not parse SHARELATEX_LEFT_FOOTER, not valid JSON')
  270. }
  271. }
  272. if (process.env.SHARELATEX_RIGHT_FOOTER != null) {
  273. settings.nav.right_footer = process.env.SHARELATEX_RIGHT_FOOTER
  274. try {
  275. settings.nav.right_footer = JSON.parse(process.env.SHARELATEX_RIGHT_FOOTER)
  276. } catch (error1) {
  277. e = error1
  278. console.error('could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON')
  279. }
  280. }
  281. if (process.env.SHARELATEX_HEADER_IMAGE_URL != null) {
  282. settings.nav.custom_logo = process.env.SHARELATEX_HEADER_IMAGE_URL
  283. }
  284. if (process.env.SHARELATEX_HEADER_NAV_LINKS != null) {
  285. console.error(`\
  286. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  287. #
  288. # WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported
  289. # See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo
  290. #
  291. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  292. `)
  293. }
  294. if (process.env.SHARELATEX_HEADER_EXTRAS != null) {
  295. try {
  296. settings.nav.header_extras = JSON.parse(
  297. process.env.SHARELATEX_HEADER_EXTRAS
  298. )
  299. } catch (error2) {
  300. e = error2
  301. console.error('could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON')
  302. }
  303. }
  304. // Sending Email
  305. // -------------
  306. //
  307. // You must configure a mail server to be able to send invite emails from
  308. // ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer
  309. // documentation for available options:
  310. //
  311. // http://www.nodemailer.com/docs/transports
  312. if (process.env.SHARELATEX_EMAIL_FROM_ADDRESS != null) {
  313. settings.email = {
  314. fromAddress: process.env.SHARELATEX_EMAIL_FROM_ADDRESS,
  315. replyTo: process.env.SHARELATEX_EMAIL_REPLY_TO || '',
  316. driver: process.env.SHARELATEX_EMAIL_DRIVER,
  317. parameters: {
  318. // AWS Creds
  319. AWSAccessKeyID: process.env.SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID,
  320. AWSSecretKey: process.env.SHARELATEX_EMAIL_AWS_SES_SECRET_KEY,
  321. // SMTP Creds
  322. host: process.env.SHARELATEX_EMAIL_SMTP_HOST,
  323. port: process.env.SHARELATEX_EMAIL_SMTP_PORT,
  324. secure: parse(process.env.SHARELATEX_EMAIL_SMTP_SECURE),
  325. ignoreTLS: parse(process.env.SHARELATEX_EMAIL_SMTP_IGNORE_TLS),
  326. name: process.env.SHARELATEX_EMAIL_SMTP_NAME,
  327. logger: process.env.SHARELATEX_EMAIL_SMTP_LOGGER === 'true',
  328. },
  329. textEncoding: process.env.SHARELATEX_EMAIL_TEXT_ENCODING,
  330. template: {
  331. customFooter: process.env.SHARELATEX_CUSTOM_EMAIL_FOOTER,
  332. },
  333. }
  334. if (process.env.SHARELATEX_EMAIL_AWS_SES_REGION != null) {
  335. settings.email.parameters.region =
  336. process.env.SHARELATEX_EMAIL_AWS_SES_REGION
  337. }
  338. if (
  339. process.env.SHARELATEX_EMAIL_SMTP_USER != null ||
  340. process.env.SHARELATEX_EMAIL_SMTP_PASS != null
  341. ) {
  342. settings.email.parameters.auth = {
  343. user: process.env.SHARELATEX_EMAIL_SMTP_USER,
  344. pass: process.env.SHARELATEX_EMAIL_SMTP_PASS,
  345. }
  346. }
  347. if (process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH != null) {
  348. settings.email.parameters.tls = {
  349. rejectUnauthorized: parse(
  350. process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH
  351. ),
  352. }
  353. }
  354. }
  355. // i18n
  356. if (process.env.SHARELATEX_LANG_DOMAIN_MAPPING != null) {
  357. settings.i18n.subdomainLang = parse(
  358. process.env.SHARELATEX_LANG_DOMAIN_MAPPING
  359. )
  360. }
  361. // Password Settings
  362. // -----------
  363. // These restrict the passwords users can use when registering
  364. // opts are from http://antelle.github.io/passfield
  365. if (
  366. process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN ||
  367. process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH ||
  368. process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH
  369. ) {
  370. settings.passwordStrengthOptions = {
  371. pattern: process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN || 'aA$3',
  372. length: {
  373. min: process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH || 8,
  374. max: process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH || 150,
  375. },
  376. }
  377. }
  378. // ######################
  379. // ShareLaTeX Server Pro
  380. // ######################
  381. if (parse(process.env.SHARELATEX_IS_SERVER_PRO) === true) {
  382. settings.bypassPercentageRollouts = true
  383. settings.apis.references = { url: 'http://localhost:3040' }
  384. }
  385. // LDAP - SERVER PRO ONLY
  386. // ----------
  387. if (process.env.SHARELATEX_LDAP_HOST) {
  388. console.error(`\
  389. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  390. #
  391. # WARNING: The LDAP configuration format has changed in version 0.5.1
  392. # See https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-LDAP-Config
  393. #
  394. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  395. `)
  396. }
  397. if (process.env.SHARELATEX_LDAP_URL) {
  398. let _ldap_connect_timeout,
  399. _ldap_group_search_attribs,
  400. _ldap_search_attribs,
  401. _ldap_timeout
  402. settings.externalAuth = true
  403. settings.ldap = {
  404. emailAtt: process.env.SHARELATEX_LDAP_EMAIL_ATT,
  405. nameAtt: process.env.SHARELATEX_LDAP_NAME_ATT,
  406. lastNameAtt: process.env.SHARELATEX_LDAP_LAST_NAME_ATT,
  407. updateUserDetailsOnLogin:
  408. process.env.SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  409. placeholder: process.env.SHARELATEX_LDAP_PLACEHOLDER,
  410. server: {
  411. url: process.env.SHARELATEX_LDAP_URL,
  412. bindDn: process.env.SHARELATEX_LDAP_BIND_DN,
  413. bindCredentials: process.env.SHARELATEX_LDAP_BIND_CREDENTIALS,
  414. bindProperty: process.env.SHARELATEX_LDAP_BIND_PROPERTY,
  415. searchBase: process.env.SHARELATEX_LDAP_SEARCH_BASE,
  416. searchScope: process.env.SHARELATEX_LDAP_SEARCH_SCOPE,
  417. searchFilter: process.env.SHARELATEX_LDAP_SEARCH_FILTER,
  418. searchAttributes: (_ldap_search_attribs =
  419. process.env.SHARELATEX_LDAP_SEARCH_ATTRIBUTES)
  420. ? (() => {
  421. try {
  422. return JSON.parse(_ldap_search_attribs)
  423. } catch (error3) {
  424. e = error3
  425. return console.error(
  426. 'could not parse SHARELATEX_LDAP_SEARCH_ATTRIBUTES'
  427. )
  428. }
  429. })()
  430. : undefined,
  431. groupDnProperty: process.env.SHARELATEX_LDAP_GROUP_DN_PROPERTY,
  432. groupSearchBase: process.env.SHARELATEX_LDAP_GROUP_SEARCH_BASE,
  433. groupSearchScope: process.env.SHARELATEX_LDAP_GROUP_SEARCH_SCOPE,
  434. groupSearchFilter: process.env.SHARELATEX_LDAP_GROUP_SEARCH_FILTER,
  435. groupSearchAttributes: (_ldap_group_search_attribs =
  436. process.env.SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES)
  437. ? (() => {
  438. try {
  439. return JSON.parse(_ldap_group_search_attribs)
  440. } catch (error4) {
  441. e = error4
  442. return console.error(
  443. 'could not parse SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES'
  444. )
  445. }
  446. })()
  447. : undefined,
  448. cache: process.env.SHARELATEX_LDAP_CACHE === 'true',
  449. timeout: (_ldap_timeout = process.env.SHARELATEX_LDAP_TIMEOUT)
  450. ? (() => {
  451. try {
  452. return parseIntOrFail(_ldap_timeout)
  453. } catch (error5) {
  454. e = error5
  455. return console.error('Cannot parse SHARELATEX_LDAP_TIMEOUT')
  456. }
  457. })()
  458. : undefined,
  459. connectTimeout: (_ldap_connect_timeout =
  460. process.env.SHARELATEX_LDAP_CONNECT_TIMEOUT)
  461. ? (() => {
  462. try {
  463. return parseIntOrFail(_ldap_connect_timeout)
  464. } catch (error6) {
  465. e = error6
  466. return console.error(
  467. 'Cannot parse SHARELATEX_LDAP_CONNECT_TIMEOUT'
  468. )
  469. }
  470. })()
  471. : undefined,
  472. },
  473. }
  474. if (process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH) {
  475. let ca, ca_paths
  476. try {
  477. ca = JSON.parse(process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH)
  478. } catch (error7) {
  479. e = error7
  480. console.error(
  481. 'could not parse SHARELATEX_LDAP_TLS_OPTS_CA_PATH, invalid JSON'
  482. )
  483. }
  484. if (typeof ca === 'string') {
  485. ca_paths = [ca]
  486. } else if (
  487. typeof ca === 'object' &&
  488. (ca != null ? ca.length : undefined) != null
  489. ) {
  490. ca_paths = ca
  491. } else {
  492. console.error('problem parsing SHARELATEX_LDAP_TLS_OPTS_CA_PATH')
  493. }
  494. settings.ldap.server.tlsOptions = {
  495. rejectUnauthorized:
  496. process.env.SHARELATEX_LDAP_TLS_OPTS_REJECT_UNAUTH === 'true',
  497. ca: ca_paths, // e.g.'/etc/ldap/ca_certs.pem'
  498. }
  499. }
  500. }
  501. if (process.env.SHARELATEX_SAML_ENTRYPOINT) {
  502. // NOTE: see https://github.com/node-saml/passport-saml/blob/master/README.md for docs of `server` options
  503. let _saml_additionalAuthorizeParams,
  504. _saml_additionalLogoutParams,
  505. _saml_additionalParams,
  506. _saml_expiration,
  507. _saml_skew
  508. settings.externalAuth = true
  509. settings.saml = {
  510. updateUserDetailsOnLogin:
  511. process.env.SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  512. identityServiceName: process.env.SHARELATEX_SAML_IDENTITY_SERVICE_NAME,
  513. emailField:
  514. process.env.SHARELATEX_SAML_EMAIL_FIELD ||
  515. process.env.SHARELATEX_SAML_EMAIL_FIELD_NAME,
  516. firstNameField: process.env.SHARELATEX_SAML_FIRST_NAME_FIELD,
  517. lastNameField: process.env.SHARELATEX_SAML_LAST_NAME_FIELD,
  518. server: {
  519. // strings
  520. entryPoint: process.env.SHARELATEX_SAML_ENTRYPOINT,
  521. callbackUrl: process.env.SHARELATEX_SAML_CALLBACK_URL,
  522. issuer: process.env.SHARELATEX_SAML_ISSUER,
  523. decryptionPvk: process.env.SHARELATEX_SAML_DECRYPTION_PVK,
  524. decryptionCert: process.env.SHARELATEX_SAML_DECRYPTION_CERT,
  525. signingCert: process.env.SHARELATEX_SAML_SIGNING_CERT,
  526. signatureAlgorithm: process.env.SHARELATEX_SAML_SIGNATURE_ALGORITHM,
  527. identifierFormat: process.env.SHARELATEX_SAML_IDENTIFIER_FORMAT,
  528. attributeConsumingServiceIndex:
  529. process.env.SHARELATEX_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX,
  530. authnContext:
  531. process.env.SHARELATEX_SAML_AUTHN_CONTEXT &&
  532. process.env.SHARELATEX_SAML_AUTHN_CONTEXT.split(','),
  533. authnRequestBinding: process.env.SHARELATEX_SAML_AUTHN_REQUEST_BINDING,
  534. validateInResponseTo: process.env.SHARELATEX_SAML_VALIDATE_IN_RESPONSE_TO,
  535. cacheProvider: process.env.SHARELATEX_SAML_CACHE_PROVIDER,
  536. logoutUrl: process.env.SHARELATEX_SAML_LOGOUT_URL,
  537. logoutCallbackUrl: process.env.SHARELATEX_SAML_LOGOUT_CALLBACK_URL,
  538. disableRequestedAuthnContext:
  539. process.env.SHARELATEX_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT === 'true',
  540. forceAuthn: process.env.SHARELATEX_SAML_FORCE_AUTHN === 'true',
  541. skipRequestCompression:
  542. process.env.SHARELATEX_SAML_SKIP_REQUEST_COMPRESSION === 'true',
  543. acceptedClockSkewMs: (_saml_skew =
  544. process.env.SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS)
  545. ? (() => {
  546. try {
  547. return parseIntOrFail(_saml_skew)
  548. } catch (error8) {
  549. e = error8
  550. return console.error(
  551. 'Cannot parse SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS'
  552. )
  553. }
  554. })()
  555. : undefined,
  556. requestIdExpirationPeriodMs: (_saml_expiration =
  557. process.env.SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS)
  558. ? (() => {
  559. try {
  560. return parseIntOrFail(_saml_expiration)
  561. } catch (error9) {
  562. e = error9
  563. return console.error(
  564. 'Cannot parse SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS'
  565. )
  566. }
  567. })()
  568. : undefined,
  569. additionalParams: (_saml_additionalParams =
  570. process.env.SHARELATEX_SAML_ADDITIONAL_PARAMS)
  571. ? (() => {
  572. try {
  573. return JSON.parse(_saml_additionalParams)
  574. } catch (error10) {
  575. e = error10
  576. return console.error(
  577. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_PARAMS'
  578. )
  579. }
  580. })()
  581. : undefined,
  582. additionalAuthorizeParams: (_saml_additionalAuthorizeParams =
  583. process.env.SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS)
  584. ? (() => {
  585. try {
  586. return JSON.parse(_saml_additionalAuthorizeParams)
  587. } catch (error11) {
  588. e = error11
  589. return console.error(
  590. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS'
  591. )
  592. }
  593. })()
  594. : undefined,
  595. additionalLogoutParams: (_saml_additionalLogoutParams =
  596. process.env.SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS)
  597. ? (() => {
  598. try {
  599. return JSON.parse(_saml_additionalLogoutParams)
  600. } catch (error12) {
  601. e = error12
  602. return console.error(
  603. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS'
  604. )
  605. }
  606. })()
  607. : undefined,
  608. },
  609. }
  610. // SHARELATEX_SAML_CERT cannot be empty
  611. // https://github.com/node-saml/passport-saml/commit/f6b1c885c0717f1083c664345556b535f217c102
  612. if (process.env.SHARELATEX_SAML_CERT) {
  613. settings.saml.server.cert = process.env.SHARELATEX_SAML_CERT
  614. settings.saml.server.privateKey = process.env.SHARELATEX_SAML_PRIVATE_CERT
  615. }
  616. }
  617. // Compiler
  618. // --------
  619. if (process.env.SANDBOXED_COMPILES === 'true') {
  620. settings.clsi = {
  621. dockerRunner: true,
  622. docker: {
  623. image: process.env.TEX_LIVE_DOCKER_IMAGE,
  624. env: {
  625. HOME: '/tmp',
  626. PATH:
  627. process.env.COMPILER_PATH ||
  628. '/usr/local/texlive/2015/bin/x86_64-linux:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin',
  629. },
  630. user: 'www-data',
  631. },
  632. }
  633. if (settings.path == null) {
  634. settings.path = {}
  635. }
  636. settings.path.synctexBaseDir = () => '/compile'
  637. if (process.env.SANDBOXED_COMPILES_SIBLING_CONTAINERS === 'true') {
  638. console.log('Using sibling containers for sandboxed compiles')
  639. if (process.env.SANDBOXED_COMPILES_HOST_DIR) {
  640. settings.path.sandboxedCompilesHostDir =
  641. process.env.SANDBOXED_COMPILES_HOST_DIR
  642. } else {
  643. console.error(
  644. 'Sibling containers, but SANDBOXED_COMPILES_HOST_DIR not set'
  645. )
  646. }
  647. }
  648. }
  649. // Templates
  650. // ---------
  651. if (process.env.SHARELATEX_TEMPLATES_USER_ID) {
  652. settings.templates = {
  653. mountPointUrl: '/templates',
  654. user_id: process.env.SHARELATEX_TEMPLATES_USER_ID,
  655. }
  656. settings.templateLinks = parse(
  657. process.env.SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS
  658. )
  659. }
  660. // /Learn
  661. // -------
  662. if (process.env.SHARELATEX_PROXY_LEARN != null) {
  663. settings.proxyLearn = parse(process.env.SHARELATEX_PROXY_LEARN)
  664. if (settings.proxyLearn) {
  665. settings.nav.header_extras = [
  666. {
  667. url: '/learn',
  668. text: 'documentation',
  669. },
  670. ].concat(settings.nav.header_extras || [])
  671. }
  672. }
  673. // /References
  674. // -----------
  675. if (process.env.SHARELATEX_ELASTICSEARCH_URL != null) {
  676. settings.references.elasticsearch = {
  677. host: process.env.SHARELATEX_ELASTICSEARCH_URL,
  678. }
  679. }
  680. // filestore
  681. switch (process.env.SHARELATEX_FILESTORE_BACKEND) {
  682. case 's3':
  683. settings.filestore = {
  684. backend: 's3',
  685. stores: {
  686. user_files: process.env.SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME,
  687. template_files:
  688. process.env.SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME,
  689. },
  690. s3: {
  691. key:
  692. process.env.SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID ||
  693. process.env.AWS_ACCESS_KEY_ID,
  694. secret:
  695. process.env.SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY ||
  696. process.env.AWS_SECRET_ACCESS_KEY,
  697. endpoint: process.env.SHARELATEX_FILESTORE_S3_ENDPOINT,
  698. pathStyle: process.env.SHARELATEX_FILESTORE_S3_PATH_STYLE === 'true',
  699. region:
  700. process.env.SHARELATEX_FILESTORE_S3_REGION ||
  701. process.env.AWS_DEFAULT_REGION,
  702. },
  703. }
  704. break
  705. default:
  706. settings.filestore = {
  707. backend: 'fs',
  708. stores: {
  709. user_files: Path.join(DATA_DIR, 'user_files'),
  710. template_files: Path.join(DATA_DIR, 'template_files'),
  711. },
  712. }
  713. }
  714. // With lots of incoming and outgoing HTTP connections to different services,
  715. // sometimes long running, it is a good idea to increase the default number
  716. // of sockets that Node will hold open.
  717. const http = require('http')
  718. http.globalAgent.maxSockets = 300
  719. const https = require('https')
  720. https.globalAgent.maxSockets = 300
  721. module.exports = settings