settings.js 24 KB

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