settings.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771
  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. // File storage
  159. // ------------
  160. // ShareLaTeX can store binary files like images either locally or in Amazon
  161. // S3. The default is locally:
  162. filestore: {
  163. backend: 'fs',
  164. stores: {
  165. user_files: Path.join(DATA_DIR, 'user_files'),
  166. template_files: Path.join(DATA_DIR, 'template_files'),
  167. },
  168. },
  169. // To use Amazon S3 as a storage backend, comment out the above config, and
  170. // uncomment the following, filling in your key, secret, and bucket name:
  171. //
  172. // filestore:
  173. // backend: "s3"
  174. // stores:
  175. // user_files: "BUCKET_NAME"
  176. // s3:
  177. // key: "AWS_KEY"
  178. // secret: "AWS_SECRET"
  179. //
  180. trackchanges: {
  181. continueOnError: true,
  182. },
  183. // Local disk caching
  184. // ------------------
  185. path: {
  186. // If we ever need to write something to disk (e.g. incoming requests
  187. // that need processing but may be too big for memory), then write
  188. // them to disk here:
  189. dumpFolder: Path.join(TMP_DIR, 'dumpFolder'),
  190. // Where to write uploads before they are processed
  191. uploadFolder: Path.join(TMP_DIR, 'uploads'),
  192. // Where to write the project to disk before running LaTeX on it
  193. compilesDir: Path.join(DATA_DIR, 'compiles'),
  194. // Where to cache downloaded URLs for the CLSI
  195. clsiCacheDir: Path.join(DATA_DIR, 'cache'),
  196. // Where to write the output files to disk after running LaTeX
  197. outputDir: Path.join(DATA_DIR, 'output'),
  198. },
  199. // Server Config
  200. // -------------
  201. // Where your instance of ShareLaTeX can be found publicly. This is used
  202. // when emails are sent out and in generated links:
  203. siteUrl: (siteUrl = process.env.SHARELATEX_SITE_URL || 'http://localhost'),
  204. // Status page URL as displayed on the maintenance/500 pages.
  205. statusPageUrl: process.env.SHARELATEX_STATUS_PAGE_URL,
  206. // The name this is used to describe your ShareLaTeX Installation
  207. appName: process.env.SHARELATEX_APP_NAME || 'ShareLaTeX (Community Edition)',
  208. restrictInvitesToExistingAccounts:
  209. process.env.SHARELATEX_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS === 'true',
  210. nav: {
  211. title:
  212. process.env.SHARELATEX_NAV_TITLE ||
  213. process.env.SHARELATEX_APP_NAME ||
  214. 'ShareLaTeX Community Edition',
  215. },
  216. // The email address which users will be directed to as the main point of
  217. // contact for this installation of ShareLaTeX.
  218. adminEmail: process.env.SHARELATEX_ADMIN_EMAIL || 'placeholder@example.com',
  219. // If provided, a sessionSecret is used to sign cookies so that they cannot be
  220. // spoofed. This is recommended.
  221. security: {
  222. sessionSecret:
  223. process.env.SHARELATEX_SESSION_SECRET || process.env.CRYPTO_RANDOM,
  224. },
  225. // These credentials are used for authenticating api requests
  226. // between services that may need to go over public channels
  227. httpAuthUsers,
  228. // Should javascript assets be served minified or not.
  229. useMinifiedJs: true,
  230. // Should static assets be sent with a header to tell the browser to cache
  231. // them. This should be false in development where changes are being made,
  232. // but should be set to true in production.
  233. cacheStaticAssets: true,
  234. // If you are running ShareLaTeX over https, set this to true to send the
  235. // cookie with a secure flag (recommended).
  236. secureCookie: process.env.SHARELATEX_SECURE_COOKIE != null,
  237. // If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  238. // then set this to true to allow it to correctly detect the forwarded IP
  239. // address and http/https protocol information.
  240. behindProxy: process.env.SHARELATEX_BEHIND_PROXY || false,
  241. i18n: {
  242. subdomainLang: {
  243. www: {
  244. lngCode: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  245. url: siteUrl,
  246. },
  247. },
  248. defaultLng: process.env.SHARELATEX_SITE_LANGUAGE || 'en',
  249. },
  250. currentImageName: process.env.TEX_LIVE_DOCKER_IMAGE,
  251. apis: {
  252. web: {
  253. url: 'http://localhost:3000',
  254. user: httpAuthUser,
  255. pass: httpAuthPass,
  256. },
  257. project_history: {
  258. sendProjectStructureOps: true,
  259. initializeHistoryForNewProjects: true,
  260. displayHistoryForNewProjects: true,
  261. url: 'http://localhost:3054',
  262. },
  263. v1_history: {
  264. url: 'http://localhost:3100/api',
  265. user: 'staging',
  266. pass: process.env.STAGING_PASSWORD,
  267. }
  268. },
  269. references: {},
  270. notifications: undefined,
  271. defaultFeatures: {
  272. collaborators: -1,
  273. dropbox: true,
  274. versioning: true,
  275. compileTimeout: parseIntOrFail(process.env.COMPILE_TIMEOUT || 180),
  276. compileGroup: 'standard',
  277. trackChanges: true,
  278. templates: true,
  279. references: true,
  280. },
  281. }
  282. // # OPTIONAL CONFIGURABLE SETTINGS
  283. if (process.env.SHARELATEX_LEFT_FOOTER != null) {
  284. try {
  285. settings.nav.left_footer = JSON.parse(process.env.SHARELATEX_LEFT_FOOTER)
  286. } catch (error) {
  287. e = error
  288. console.error('could not parse SHARELATEX_LEFT_FOOTER, not valid JSON')
  289. }
  290. }
  291. if (process.env.SHARELATEX_RIGHT_FOOTER != null) {
  292. settings.nav.right_footer = process.env.SHARELATEX_RIGHT_FOOTER
  293. try {
  294. settings.nav.right_footer = JSON.parse(process.env.SHARELATEX_RIGHT_FOOTER)
  295. } catch (error1) {
  296. e = error1
  297. console.error('could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON')
  298. }
  299. }
  300. if (process.env.SHARELATEX_HEADER_IMAGE_URL != null) {
  301. settings.nav.custom_logo = process.env.SHARELATEX_HEADER_IMAGE_URL
  302. }
  303. if (process.env.SHARELATEX_HEADER_NAV_LINKS != null) {
  304. console.error(`\
  305. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  306. #
  307. # WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported
  308. # See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo
  309. #
  310. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  311. `)
  312. }
  313. if (process.env.SHARELATEX_HEADER_EXTRAS != null) {
  314. try {
  315. settings.nav.header_extras = JSON.parse(
  316. process.env.SHARELATEX_HEADER_EXTRAS
  317. )
  318. } catch (error2) {
  319. e = error2
  320. console.error('could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON')
  321. }
  322. }
  323. // Sending Email
  324. // -------------
  325. //
  326. // You must configure a mail server to be able to send invite emails from
  327. // ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer
  328. // documentation for available options:
  329. //
  330. // http://www.nodemailer.com/docs/transports
  331. if (process.env.SHARELATEX_EMAIL_FROM_ADDRESS != null) {
  332. settings.email = {
  333. fromAddress: process.env.SHARELATEX_EMAIL_FROM_ADDRESS,
  334. replyTo: process.env.SHARELATEX_EMAIL_REPLY_TO || '',
  335. driver: process.env.SHARELATEX_EMAIL_DRIVER,
  336. parameters: {
  337. // AWS Creds
  338. AWSAccessKeyID: process.env.SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID,
  339. AWSSecretKey: process.env.SHARELATEX_EMAIL_AWS_SES_SECRET_KEY,
  340. // SMTP Creds
  341. host: process.env.SHARELATEX_EMAIL_SMTP_HOST,
  342. port: process.env.SHARELATEX_EMAIL_SMTP_PORT,
  343. secure: parse(process.env.SHARELATEX_EMAIL_SMTP_SECURE),
  344. ignoreTLS: parse(process.env.SHARELATEX_EMAIL_SMTP_IGNORE_TLS),
  345. name: process.env.SHARELATEX_EMAIL_SMTP_NAME,
  346. logger: process.env.SHARELATEX_EMAIL_SMTP_LOGGER === 'true',
  347. },
  348. textEncoding: process.env.SHARELATEX_EMAIL_TEXT_ENCODING,
  349. template: {
  350. customFooter: process.env.SHARELATEX_CUSTOM_EMAIL_FOOTER,
  351. },
  352. }
  353. if (process.env.SHARELATEX_EMAIL_AWS_SES_REGION != null) {
  354. settings.email.parameters.region =
  355. process.env.SHARELATEX_EMAIL_AWS_SES_REGION
  356. }
  357. if (
  358. process.env.SHARELATEX_EMAIL_SMTP_USER != null ||
  359. process.env.SHARELATEX_EMAIL_SMTP_PASS != null
  360. ) {
  361. settings.email.parameters.auth = {
  362. user: process.env.SHARELATEX_EMAIL_SMTP_USER,
  363. pass: process.env.SHARELATEX_EMAIL_SMTP_PASS,
  364. }
  365. }
  366. if (process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH != null) {
  367. settings.email.parameters.tls = {
  368. rejectUnauthorized: parse(
  369. process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH
  370. ),
  371. }
  372. }
  373. }
  374. // i18n
  375. if (process.env.SHARELATEX_LANG_DOMAIN_MAPPING != null) {
  376. settings.i18n.subdomainLang = parse(
  377. process.env.SHARELATEX_LANG_DOMAIN_MAPPING
  378. )
  379. }
  380. // Password Settings
  381. // -----------
  382. // These restrict the passwords users can use when registering
  383. // opts are from http://antelle.github.io/passfield
  384. if (
  385. process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN ||
  386. process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH ||
  387. process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH
  388. ) {
  389. settings.passwordStrengthOptions = {
  390. pattern: process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN || 'aA$3',
  391. length: {
  392. min: process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH || 8,
  393. max: process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH || 150,
  394. },
  395. }
  396. }
  397. // ######################
  398. // ShareLaTeX Server Pro
  399. // ######################
  400. if (parse(process.env.SHARELATEX_IS_SERVER_PRO) === true) {
  401. settings.bypassPercentageRollouts = true
  402. settings.apis.references = { url: 'http://localhost:3040' }
  403. }
  404. // LDAP - SERVER PRO ONLY
  405. // ----------
  406. if (process.env.SHARELATEX_LDAP_HOST) {
  407. console.error(`\
  408. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  409. #
  410. # WARNING: The LDAP configuration format has changed in version 0.5.1
  411. # See https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-LDAP-Config
  412. #
  413. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\
  414. `)
  415. }
  416. if (process.env.SHARELATEX_LDAP_URL) {
  417. let _ldap_connect_timeout,
  418. _ldap_group_search_attribs,
  419. _ldap_search_attribs,
  420. _ldap_timeout
  421. settings.externalAuth = true
  422. settings.ldap = {
  423. emailAtt: process.env.SHARELATEX_LDAP_EMAIL_ATT,
  424. nameAtt: process.env.SHARELATEX_LDAP_NAME_ATT,
  425. lastNameAtt: process.env.SHARELATEX_LDAP_LAST_NAME_ATT,
  426. updateUserDetailsOnLogin:
  427. process.env.SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  428. placeholder: process.env.SHARELATEX_LDAP_PLACEHOLDER,
  429. server: {
  430. url: process.env.SHARELATEX_LDAP_URL,
  431. bindDn: process.env.SHARELATEX_LDAP_BIND_DN,
  432. bindCredentials: process.env.SHARELATEX_LDAP_BIND_CREDENTIALS,
  433. bindProperty: process.env.SHARELATEX_LDAP_BIND_PROPERTY,
  434. searchBase: process.env.SHARELATEX_LDAP_SEARCH_BASE,
  435. searchScope: process.env.SHARELATEX_LDAP_SEARCH_SCOPE,
  436. searchFilter: process.env.SHARELATEX_LDAP_SEARCH_FILTER,
  437. searchAttributes: (_ldap_search_attribs =
  438. process.env.SHARELATEX_LDAP_SEARCH_ATTRIBUTES)
  439. ? (() => {
  440. try {
  441. return JSON.parse(_ldap_search_attribs)
  442. } catch (error3) {
  443. e = error3
  444. return console.error(
  445. 'could not parse SHARELATEX_LDAP_SEARCH_ATTRIBUTES'
  446. )
  447. }
  448. })()
  449. : undefined,
  450. groupDnProperty: process.env.SHARELATEX_LDAP_GROUP_DN_PROPERTY,
  451. groupSearchBase: process.env.SHARELATEX_LDAP_GROUP_SEARCH_BASE,
  452. groupSearchScope: process.env.SHARELATEX_LDAP_GROUP_SEARCH_SCOPE,
  453. groupSearchFilter: process.env.SHARELATEX_LDAP_GROUP_SEARCH_FILTER,
  454. groupSearchAttributes: (_ldap_group_search_attribs =
  455. process.env.SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES)
  456. ? (() => {
  457. try {
  458. return JSON.parse(_ldap_group_search_attribs)
  459. } catch (error4) {
  460. e = error4
  461. return console.error(
  462. 'could not parse SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES'
  463. )
  464. }
  465. })()
  466. : undefined,
  467. cache: process.env.SHARELATEX_LDAP_CACHE === 'true',
  468. timeout: (_ldap_timeout = process.env.SHARELATEX_LDAP_TIMEOUT)
  469. ? (() => {
  470. try {
  471. return parseIntOrFail(_ldap_timeout)
  472. } catch (error5) {
  473. e = error5
  474. return console.error('Cannot parse SHARELATEX_LDAP_TIMEOUT')
  475. }
  476. })()
  477. : undefined,
  478. connectTimeout: (_ldap_connect_timeout =
  479. process.env.SHARELATEX_LDAP_CONNECT_TIMEOUT)
  480. ? (() => {
  481. try {
  482. return parseIntOrFail(_ldap_connect_timeout)
  483. } catch (error6) {
  484. e = error6
  485. return console.error(
  486. 'Cannot parse SHARELATEX_LDAP_CONNECT_TIMEOUT'
  487. )
  488. }
  489. })()
  490. : undefined,
  491. },
  492. }
  493. if (process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH) {
  494. let ca, ca_paths
  495. try {
  496. ca = JSON.parse(process.env.SHARELATEX_LDAP_TLS_OPTS_CA_PATH)
  497. } catch (error7) {
  498. e = error7
  499. console.error(
  500. 'could not parse SHARELATEX_LDAP_TLS_OPTS_CA_PATH, invalid JSON'
  501. )
  502. }
  503. if (typeof ca === 'string') {
  504. ca_paths = [ca]
  505. } else if (
  506. typeof ca === 'object' &&
  507. (ca != null ? ca.length : undefined) != null
  508. ) {
  509. ca_paths = ca
  510. } else {
  511. console.error('problem parsing SHARELATEX_LDAP_TLS_OPTS_CA_PATH')
  512. }
  513. settings.ldap.server.tlsOptions = {
  514. rejectUnauthorized:
  515. process.env.SHARELATEX_LDAP_TLS_OPTS_REJECT_UNAUTH === 'true',
  516. ca: ca_paths, // e.g.'/etc/ldap/ca_certs.pem'
  517. }
  518. }
  519. }
  520. if (process.env.SHARELATEX_SAML_ENTRYPOINT) {
  521. // NOTE: see https://github.com/node-saml/passport-saml/blob/master/README.md for docs of `server` options
  522. let _saml_additionalAuthorizeParams,
  523. _saml_additionalLogoutParams,
  524. _saml_additionalParams,
  525. _saml_expiration,
  526. _saml_skew
  527. settings.externalAuth = true
  528. settings.saml = {
  529. updateUserDetailsOnLogin:
  530. process.env.SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN === 'true',
  531. identityServiceName: process.env.SHARELATEX_SAML_IDENTITY_SERVICE_NAME,
  532. emailField:
  533. process.env.SHARELATEX_SAML_EMAIL_FIELD ||
  534. process.env.SHARELATEX_SAML_EMAIL_FIELD_NAME,
  535. firstNameField: process.env.SHARELATEX_SAML_FIRST_NAME_FIELD,
  536. lastNameField: process.env.SHARELATEX_SAML_LAST_NAME_FIELD,
  537. server: {
  538. // strings
  539. entryPoint: process.env.SHARELATEX_SAML_ENTRYPOINT,
  540. callbackUrl: process.env.SHARELATEX_SAML_CALLBACK_URL,
  541. issuer: process.env.SHARELATEX_SAML_ISSUER,
  542. decryptionPvk: process.env.SHARELATEX_SAML_DECRYPTION_PVK,
  543. decryptionCert: process.env.SHARELATEX_SAML_DECRYPTION_CERT,
  544. signingCert: process.env.SHARELATEX_SAML_SIGNING_CERT,
  545. signatureAlgorithm: process.env.SHARELATEX_SAML_SIGNATURE_ALGORITHM,
  546. identifierFormat: process.env.SHARELATEX_SAML_IDENTIFIER_FORMAT,
  547. attributeConsumingServiceIndex:
  548. process.env.SHARELATEX_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX,
  549. authnContext:
  550. process.env.SHARELATEX_SAML_AUTHN_CONTEXT &&
  551. process.env.SHARELATEX_SAML_AUTHN_CONTEXT.split(','),
  552. authnRequestBinding: process.env.SHARELATEX_SAML_AUTHN_REQUEST_BINDING,
  553. validateInResponseTo: process.env.SHARELATEX_SAML_VALIDATE_IN_RESPONSE_TO,
  554. cacheProvider: process.env.SHARELATEX_SAML_CACHE_PROVIDER,
  555. logoutUrl: process.env.SHARELATEX_SAML_LOGOUT_URL,
  556. logoutCallbackUrl: process.env.SHARELATEX_SAML_LOGOUT_CALLBACK_URL,
  557. disableRequestedAuthnContext:
  558. process.env.SHARELATEX_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT === 'true',
  559. forceAuthn: process.env.SHARELATEX_SAML_FORCE_AUTHN === 'true',
  560. skipRequestCompression:
  561. process.env.SHARELATEX_SAML_SKIP_REQUEST_COMPRESSION === 'true',
  562. acceptedClockSkewMs: (_saml_skew =
  563. process.env.SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS)
  564. ? (() => {
  565. try {
  566. return parseIntOrFail(_saml_skew)
  567. } catch (error8) {
  568. e = error8
  569. return console.error(
  570. 'Cannot parse SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS'
  571. )
  572. }
  573. })()
  574. : undefined,
  575. requestIdExpirationPeriodMs: (_saml_expiration =
  576. process.env.SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS)
  577. ? (() => {
  578. try {
  579. return parseIntOrFail(_saml_expiration)
  580. } catch (error9) {
  581. e = error9
  582. return console.error(
  583. 'Cannot parse SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS'
  584. )
  585. }
  586. })()
  587. : undefined,
  588. additionalParams: (_saml_additionalParams =
  589. process.env.SHARELATEX_SAML_ADDITIONAL_PARAMS)
  590. ? (() => {
  591. try {
  592. return JSON.parse(_saml_additionalParams)
  593. } catch (error10) {
  594. e = error10
  595. return console.error(
  596. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_PARAMS'
  597. )
  598. }
  599. })()
  600. : undefined,
  601. additionalAuthorizeParams: (_saml_additionalAuthorizeParams =
  602. process.env.SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS)
  603. ? (() => {
  604. try {
  605. return JSON.parse(_saml_additionalAuthorizeParams)
  606. } catch (error11) {
  607. e = error11
  608. return console.error(
  609. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS'
  610. )
  611. }
  612. })()
  613. : undefined,
  614. additionalLogoutParams: (_saml_additionalLogoutParams =
  615. process.env.SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS)
  616. ? (() => {
  617. try {
  618. return JSON.parse(_saml_additionalLogoutParams)
  619. } catch (error12) {
  620. e = error12
  621. return console.error(
  622. 'Cannot parse SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS'
  623. )
  624. }
  625. })()
  626. : undefined,
  627. },
  628. }
  629. // SHARELATEX_SAML_CERT cannot be empty
  630. // https://github.com/node-saml/passport-saml/commit/f6b1c885c0717f1083c664345556b535f217c102
  631. if (process.env.SHARELATEX_SAML_CERT) {
  632. settings.saml.server.cert = process.env.SHARELATEX_SAML_CERT
  633. settings.saml.server.privateKey = process.env.SHARELATEX_SAML_PRIVATE_CERT
  634. }
  635. }
  636. // Compiler
  637. // --------
  638. if (process.env.SANDBOXED_COMPILES === 'true') {
  639. settings.clsi = {
  640. dockerRunner: true,
  641. docker: {
  642. image: process.env.TEX_LIVE_DOCKER_IMAGE,
  643. env: {
  644. HOME: '/tmp',
  645. PATH:
  646. process.env.COMPILER_PATH ||
  647. '/usr/local/texlive/2015/bin/x86_64-linux:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin',
  648. },
  649. user: 'www-data',
  650. },
  651. }
  652. if (settings.path == null) {
  653. settings.path = {}
  654. }
  655. settings.path.synctexBaseDir = () => '/compile'
  656. if (process.env.SANDBOXED_COMPILES_SIBLING_CONTAINERS === 'true') {
  657. console.log('Using sibling containers for sandboxed compiles')
  658. if (process.env.SANDBOXED_COMPILES_HOST_DIR) {
  659. settings.path.sandboxedCompilesHostDir =
  660. process.env.SANDBOXED_COMPILES_HOST_DIR
  661. } else {
  662. console.error(
  663. 'Sibling containers, but SANDBOXED_COMPILES_HOST_DIR not set'
  664. )
  665. }
  666. }
  667. }
  668. // Templates
  669. // ---------
  670. if (process.env.SHARELATEX_TEMPLATES_USER_ID) {
  671. settings.templates = {
  672. mountPointUrl: '/templates',
  673. user_id: process.env.SHARELATEX_TEMPLATES_USER_ID,
  674. }
  675. settings.templateLinks = parse(
  676. process.env.SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS
  677. )
  678. }
  679. // /Learn
  680. // -------
  681. if (process.env.SHARELATEX_PROXY_LEARN != null) {
  682. settings.proxyLearn = parse(process.env.SHARELATEX_PROXY_LEARN)
  683. if (settings.proxyLearn) {
  684. settings.nav.header_extras = [{
  685. url: '/learn',
  686. text: 'documentation',
  687. }].concat(settings.nav.header_extras || [])
  688. }
  689. }
  690. // /References
  691. // -----------
  692. if (process.env.SHARELATEX_ELASTICSEARCH_URL != null) {
  693. settings.references.elasticsearch = {
  694. host: process.env.SHARELATEX_ELASTICSEARCH_URL,
  695. }
  696. }
  697. // With lots of incoming and outgoing HTTP connections to different services,
  698. // sometimes long running, it is a good idea to increase the default number
  699. // of sockets that Node will hold open.
  700. const http = require('http')
  701. http.globalAgent.maxSockets = 300
  702. const https = require('https')
  703. https.globalAgent.maxSockets = 300
  704. module.exports = settings