settings.js 24 KB

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