settings.js 24 KB

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