settings.js 25 KB

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