settings.js 24 KB

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