settings.coffee 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572
  1. Path = require('path')
  2. # These credentials are used for authenticating api requests
  3. # between services that may need to go over public channels
  4. httpAuthUser = "sharelatex"
  5. httpAuthPass = process.env["WEB_API_PASSWORD"]
  6. httpAuthUsers = {}
  7. httpAuthUsers[httpAuthUser] = httpAuthPass
  8. parse = (option)->
  9. if option?
  10. try
  11. opt = JSON.parse(option)
  12. return opt
  13. catch err
  14. throw new Error("problem parsing #{option}, invalid JSON")
  15. parseIntOrFail = (value)->
  16. parsedValue = parseInt(value, 10)
  17. if isNaN(parsedValue)
  18. throw new Error("'#{value}' is an invalid integer")
  19. return parsedValue
  20. DATA_DIR = '/var/lib/sharelatex/data'
  21. TMP_DIR = '/var/lib/sharelatex/tmp'
  22. settings =
  23. clsi:
  24. optimiseInDocker: process.env['OPTIMISE_PDF'] == 'true'
  25. brandPrefix: ""
  26. allowAnonymousReadAndWriteSharing:
  27. process.env['SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING'] == 'true'
  28. # Databases
  29. # ---------
  30. # ShareLaTeX's main persistent data store is MongoDB (http://www.mongodb.org/)
  31. # Documentation about the URL connection string format can be found at:
  32. #
  33. # http://docs.mongodb.org/manual/reference/connection-string/
  34. #
  35. # The following works out of the box with Mongo's default settings:
  36. mongo:
  37. url : process.env["SHARELATEX_MONGO_URL"] or 'mongodb://dockerhost/sharelatex'
  38. # Redis is used in ShareLaTeX for high volume queries, like real-time
  39. # editing, and session management.
  40. #
  41. # The following config will work with Redis's default settings:
  42. redis:
  43. web: redisConfig =
  44. host: process.env["SHARELATEX_REDIS_HOST"] or "dockerhost"
  45. port: process.env["SHARELATEX_REDIS_PORT"] or "6379"
  46. password: process.env["SHARELATEX_REDIS_PASS"] or ""
  47. key_schema:
  48. # document-updater
  49. blockingKey: ({doc_id}) -> "Blocking:#{doc_id}"
  50. docLines: ({doc_id}) -> "doclines:#{doc_id}"
  51. docOps: ({doc_id}) -> "DocOps:#{doc_id}"
  52. docVersion: ({doc_id}) -> "DocVersion:#{doc_id}"
  53. docHash: ({doc_id}) -> "DocHash:#{doc_id}"
  54. projectKey: ({doc_id}) -> "ProjectId:#{doc_id}"
  55. docsInProject: ({project_id}) -> "DocsIn:#{project_id}"
  56. ranges: ({doc_id}) -> "Ranges:#{doc_id}"
  57. # document-updater:realtime
  58. pendingUpdates: ({doc_id}) -> "PendingUpdates:#{doc_id}"
  59. # document-updater:history
  60. uncompressedHistoryOps: ({doc_id}) -> "UncompressedHistoryOps:#{doc_id}"
  61. docsWithHistoryOps: ({project_id}) -> "DocsWithHistoryOps:#{project_id}"
  62. # document-updater:lock
  63. blockingKey: ({doc_id}) -> "Blocking:#{doc_id}"
  64. # track-changes:lock
  65. historyLock: ({doc_id}) -> "HistoryLock:#{doc_id}"
  66. historyIndexLock: ({project_id}) -> "HistoryIndexLock:#{project_id}"
  67. # track-changes:history
  68. uncompressedHistoryOps: ({doc_id}) -> "UncompressedHistoryOps:#{doc_id}"
  69. docsWithHistoryOps: ({project_id}) -> "DocsWithHistoryOps:#{project_id}"
  70. # realtime
  71. clientsInProject: ({project_id}) -> "clients_in_project:#{project_id}"
  72. connectedUser: ({project_id, client_id})-> "connected_user:#{project_id}:#{client_id}"
  73. fairy: redisConfig
  74. # track-changes and document-updater
  75. realtime: redisConfig
  76. documentupdater: redisConfig
  77. lock: redisConfig
  78. history: redisConfig
  79. websessions: redisConfig
  80. api: redisConfig
  81. pubsub: redisConfig
  82. project_history: redisConfig
  83. # The compile server (the clsi) uses a SQL database to cache files and
  84. # meta-data. sqlite is the default, and the load is low enough that this will
  85. # be fine in production (we use sqlite at sharelatex.com).
  86. #
  87. # If you want to configure a different database, see the Sequelize documentation
  88. # for available options:
  89. #
  90. # https://github.com/sequelize/sequelize/wiki/API-Reference-Sequelize#example-usage
  91. #
  92. mysql:
  93. clsi:
  94. database: "clsi"
  95. username: "clsi"
  96. password: ""
  97. dialect: "sqlite"
  98. storage: Path.join(DATA_DIR, "db.sqlite")
  99. # File storage
  100. # ------------
  101. # ShareLaTeX can store binary files like images either locally or in Amazon
  102. # S3. The default is locally:
  103. filestore:
  104. backend: "fs"
  105. stores:
  106. user_files: Path.join(DATA_DIR, "user_files")
  107. template_files: Path.join(DATA_DIR, "template_files")
  108. # To use Amazon S3 as a storage backend, comment out the above config, and
  109. # uncomment the following, filling in your key, secret, and bucket name:
  110. #
  111. # filestore:
  112. # backend: "s3"
  113. # stores:
  114. # user_files: "BUCKET_NAME"
  115. # s3:
  116. # key: "AWS_KEY"
  117. # secret: "AWS_SECRET"
  118. #
  119. trackchanges:
  120. continueOnError: true
  121. # Local disk caching
  122. # ------------------
  123. path:
  124. # If we ever need to write something to disk (e.g. incoming requests
  125. # that need processing but may be too big for memory), then write
  126. # them to disk here:
  127. dumpFolder: Path.join(TMP_DIR, "dumpFolder")
  128. # Where to write uploads before they are processed
  129. uploadFolder: Path.join(TMP_DIR, "uploads")
  130. # Where to write the project to disk before running LaTeX on it
  131. compilesDir: Path.join(DATA_DIR, "compiles")
  132. # Where to cache downloaded URLs for the CLSI
  133. clsiCacheDir: Path.join(DATA_DIR, "cache")
  134. # Server Config
  135. # -------------
  136. # Where your instance of ShareLaTeX can be found publicly. This is used
  137. # when emails are sent out and in generated links:
  138. siteUrl: siteUrl = process.env["SHARELATEX_SITE_URL"] or 'http://localhost'
  139. # The name this is used to describe your ShareLaTeX Installation
  140. appName: process.env["SHARELATEX_APP_NAME"] or "ShareLaTeX (Community Edition)"
  141. restrictInvitesToExistingAccounts: process.env["SHARELATEX_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS"] == 'true'
  142. nav:
  143. title: process.env["SHARELATEX_NAV_TITLE"] or process.env["SHARELATEX_APP_NAME"] or "ShareLaTeX Community Edition"
  144. # The email address which users will be directed to as the main point of
  145. # contact for this installation of ShareLaTeX.
  146. adminEmail: process.env["SHARELATEX_ADMIN_EMAIL"] or "placeholder@example.com"
  147. # If provided, a sessionSecret is used to sign cookies so that they cannot be
  148. # spoofed. This is recommended.
  149. security:
  150. sessionSecret: process.env["SHARELATEX_SESSION_SECRET"] or process.env["CRYPTO_RANDOM"]
  151. # These credentials are used for authenticating api requests
  152. # between services that may need to go over public channels
  153. httpAuthUsers: httpAuthUsers
  154. # Should javascript assets be served minified or not.
  155. useMinifiedJs: true
  156. # Should static assets be sent with a header to tell the browser to cache
  157. # them. This should be false in development where changes are being made,
  158. # but should be set to true in production.
  159. cacheStaticAssets: true
  160. # If you are running ShareLaTeX over https, set this to true to send the
  161. # cookie with a secure flag (recommended).
  162. secureCookie: process.env["SHARELATEX_SECURE_COOKIE"]?
  163. # If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  164. # then set this to true to allow it to correctly detect the forwarded IP
  165. # address and http/https protocol information.
  166. behindProxy: process.env["SHARELATEX_BEHIND_PROXY"] or false
  167. i18n:
  168. subdomainLang:
  169. www: {lngCode:process.env["SHARELATEX_SITE_LANGUAGE"] or "en", url: siteUrl}
  170. defaultLng: process.env["SHARELATEX_SITE_LANGUAGE"] or "en"
  171. currentImageName: process.env["TEX_LIVE_DOCKER_IMAGE"]
  172. apis:
  173. web:
  174. url: "http://localhost:3000"
  175. user: httpAuthUser
  176. pass: httpAuthPass
  177. project_history:
  178. enabled: false
  179. references:{}
  180. notifications:undefined
  181. defaultFeatures:
  182. collaborators: -1
  183. dropbox: true
  184. versioning: true
  185. compileTimeout: parseIntOrFail(process.env["COMPILE_TIMEOUT"] or 180)
  186. compileGroup: "standard"
  187. trackChanges: true
  188. templates: true
  189. references: true
  190. ## OPTIONAL CONFIGURABLE SETTINGS
  191. if process.env["SHARELATEX_LEFT_FOOTER"]?
  192. try
  193. settings.nav.left_footer = JSON.parse(process.env["SHARELATEX_LEFT_FOOTER"])
  194. catch e
  195. console.error("could not parse SHARELATEX_LEFT_FOOTER, not valid JSON")
  196. if process.env["SHARELATEX_RIGHT_FOOTER"]?
  197. settings.nav.right_footer = process.env["SHARELATEX_RIGHT_FOOTER"]
  198. try
  199. settings.nav.right_footer = JSON.parse(process.env["SHARELATEX_RIGHT_FOOTER"])
  200. catch e
  201. console.error("could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON")
  202. if process.env["SHARELATEX_HEADER_IMAGE_URL"]?
  203. settings.nav.custom_logo = process.env["SHARELATEX_HEADER_IMAGE_URL"]
  204. if process.env["SHARELATEX_HEADER_NAV_LINKS"]?
  205. console.error """
  206. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  207. #
  208. # WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported
  209. # See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo
  210. #
  211. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  212. """
  213. if process.env["SHARELATEX_HEADER_EXTRAS"]?
  214. try
  215. settings.nav.header_extras = JSON.parse(process.env["SHARELATEX_HEADER_EXTRAS"])
  216. catch e
  217. console.error("could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON")
  218. # Sending Email
  219. # -------------
  220. #
  221. # You must configure a mail server to be able to send invite emails from
  222. # ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer
  223. # documentation for available options:
  224. #
  225. # http://www.nodemailer.com/docs/transports
  226. if process.env["SHARELATEX_EMAIL_FROM_ADDRESS"]?
  227. settings.email =
  228. fromAddress: process.env["SHARELATEX_EMAIL_FROM_ADDRESS"]
  229. replyTo: process.env["SHARELATEX_EMAIL_REPLY_TO"] or ""
  230. driver: process.env["SHARELATEX_EMAIL_DRIVER"]
  231. parameters:
  232. #AWS Creds
  233. AWSAccessKeyID: process.env["SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID"]
  234. AWSSecretKey: process.env["SHARELATEX_EMAIL_AWS_SES_SECRET_KEY"]
  235. #SMTP Creds
  236. host: process.env["SHARELATEX_EMAIL_SMTP_HOST"]
  237. port: process.env["SHARELATEX_EMAIL_SMTP_PORT"],
  238. secure: parse(process.env["SHARELATEX_EMAIL_SMTP_SECURE"])
  239. ignoreTLS: parse(process.env["SHARELATEX_EMAIL_SMTP_IGNORE_TLS"])
  240. textEncoding: process.env["SHARELATEX_EMAIL_TEXT_ENCODING"]
  241. template:
  242. customFooter: process.env["SHARELATEX_CUSTOM_EMAIL_FOOTER"]
  243. if process.env["SHARELATEX_EMAIL_AWS_SES_REGION"]?
  244. settings.email.parameters.region = process.env["SHARELATEX_EMAIL_AWS_SES_REGION"]
  245. if process.env["SHARELATEX_EMAIL_SMTP_USER"]? or process.env["SHARELATEX_EMAIL_SMTP_PASS"]?
  246. settings.email.parameters.auth =
  247. user: process.env["SHARELATEX_EMAIL_SMTP_USER"]
  248. pass: process.env["SHARELATEX_EMAIL_SMTP_PASS"]
  249. if process.env["SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH"]?
  250. settings.email.parameters.tls =
  251. rejectUnauthorized: parse(process.env["SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH"])
  252. # i18n
  253. if process.env["SHARELATEX_LANG_DOMAIN_MAPPING"]?
  254. settings.i18n.subdomainLang = parse(process.env["SHARELATEX_LANG_DOMAIN_MAPPING"])
  255. # Password Settings
  256. # -----------
  257. # These restrict the passwords users can use when registering
  258. # opts are from http://antelle.github.io/passfield
  259. if process.env["SHARELATEX_PASSWORD_VALIDATION_PATTERN"] or process.env["SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH"] or process.env["SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH"]
  260. settings.passwordStrengthOptions =
  261. pattern: process.env["SHARELATEX_PASSWORD_VALIDATION_PATTERN"] or "aA$3"
  262. length: {min:process.env["SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH"] or 8, max: process.env["SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH"] or 150}
  263. #######################
  264. # ShareLaTeX Server Pro
  265. #######################
  266. if parse(process.env["SHARELATEX_IS_SERVER_PRO"]) == true
  267. settings.bypassPercentageRollouts = true
  268. settings.apis.references =
  269. url: "http://localhost:3040"
  270. # LDAP - SERVER PRO ONLY
  271. # ----------
  272. if process.env["SHARELATEX_LDAP_HOST"]
  273. console.error """
  274. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  275. #
  276. # WARNING: The LDAP configuration format has changed in version 0.5.1
  277. # See https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-LDAP-Config
  278. #
  279. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  280. """
  281. if process.env["SHARELATEX_LDAP_URL"]
  282. settings.externalAuth = true
  283. settings.ldap =
  284. emailAtt: process.env["SHARELATEX_LDAP_EMAIL_ATT"]
  285. nameAtt: process.env["SHARELATEX_LDAP_NAME_ATT"]
  286. lastNameAtt: process.env["SHARELATEX_LDAP_LAST_NAME_ATT"]
  287. updateUserDetailsOnLogin: process.env["SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN"] == 'true'
  288. placeholder: process.env["SHARELATEX_LDAP_PLACEHOLDER"]
  289. server:
  290. url: process.env["SHARELATEX_LDAP_URL"]
  291. bindDn: process.env["SHARELATEX_LDAP_BIND_DN"]
  292. bindCredentials: process.env["SHARELATEX_LDAP_BIND_CREDENTIALS"]
  293. bindProperty: process.env["SHARELATEX_LDAP_BIND_PROPERTY"]
  294. searchBase: process.env["SHARELATEX_LDAP_SEARCH_BASE"]
  295. searchScope: process.env["SHARELATEX_LDAP_SEARCH_SCOPE"]
  296. searchFilter: process.env["SHARELATEX_LDAP_SEARCH_FILTER"]
  297. searchAttributes: (
  298. if _ldap_search_attribs = process.env["SHARELATEX_LDAP_SEARCH_ATTRIBUTES"]
  299. try
  300. JSON.parse(_ldap_search_attribs)
  301. catch e
  302. console.error "could not parse SHARELATEX_LDAP_SEARCH_ATTRIBUTES"
  303. else
  304. undefined
  305. )
  306. groupDnProperty: process.env["SHARELATEX_LDAP_GROUP_DN_PROPERTY"]
  307. groupSearchBase: process.env["SHARELATEX_LDAP_GROUP_SEARCH_BASE"]
  308. groupSearchScope: process.env["SHARELATEX_LDAP_GROUP_SEARCH_SCOPE"]
  309. groupSearchFilter: process.env["SHARELATEX_LDAP_GROUP_SEARCH_FILTER"]
  310. groupSearchAttributes: (
  311. if _ldap_group_search_attribs = process.env["SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES"]
  312. try
  313. JSON.parse(_ldap_group_search_attribs)
  314. catch e
  315. console.error "could not parse SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES"
  316. else
  317. undefined
  318. )
  319. cache: process.env["SHARELATEX_LDAP_CACHE"] == 'true'
  320. timeout: (
  321. if _ldap_timeout = process.env["SHARELATEX_LDAP_TIMEOUT"]
  322. try
  323. parseIntOrFail(_ldap_timeout)
  324. catch e
  325. console.error "Cannot parse SHARELATEX_LDAP_TIMEOUT"
  326. else
  327. undefined
  328. )
  329. connectTimeout: (
  330. if _ldap_connect_timeout = process.env["SHARELATEX_LDAP_CONNECT_TIMEOUT"]
  331. try
  332. parseIntOrFail(_ldap_connect_timeout)
  333. catch e
  334. console.error "Cannot parse SHARELATEX_LDAP_CONNECT_TIMEOUT"
  335. else
  336. undefined
  337. )
  338. if process.env["SHARELATEX_LDAP_TLS_OPTS_CA_PATH"]
  339. try
  340. ca = JSON.parse(process.env["SHARELATEX_LDAP_TLS_OPTS_CA_PATH"])
  341. catch e
  342. console.error "could not parse SHARELATEX_LDAP_TLS_OPTS_CA_PATH, invalid JSON"
  343. if typeof(ca) == 'string'
  344. ca_paths = [ca]
  345. else if typeof(ca) == 'object' && ca?.length?
  346. ca_paths = ca
  347. else
  348. console.error "problem parsing SHARELATEX_LDAP_TLS_OPTS_CA_PATH"
  349. settings.ldap.server.tlsOptions =
  350. rejectUnauthorized: process.env["SHARELATEX_LDAP_TLS_OPTS_REJECT_UNAUTH"] == "true"
  351. ca:ca_paths # e.g.'/etc/ldap/ca_certs.pem'
  352. if process.env["SHARELATEX_SAML_ENTRYPOINT"]
  353. # NOTE: see https://github.com/node-saml/passport-saml/blob/master/README.md for docs of `server` options
  354. settings.externalAuth = true
  355. settings.saml =
  356. updateUserDetailsOnLogin: process.env["SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN"] == 'true'
  357. identityServiceName: process.env["SHARELATEX_SAML_IDENTITY_SERVICE_NAME"]
  358. emailField: process.env["SHARELATEX_SAML_EMAIL_FIELD"] || process.env["SHARELATEX_SAML_EMAIL_FIELD_NAME"]
  359. firstNameField: process.env["SHARELATEX_SAML_FIRST_NAME_FIELD"]
  360. lastNameField: process.env["SHARELATEX_SAML_LAST_NAME_FIELD"]
  361. server:
  362. # strings
  363. entryPoint: process.env["SHARELATEX_SAML_ENTRYPOINT"]
  364. callbackUrl: process.env["SHARELATEX_SAML_CALLBACK_URL"]
  365. issuer: process.env["SHARELATEX_SAML_ISSUER"]
  366. decryptionPvk: process.env["SHARELATEX_SAML_DECRYPTION_PVK"]
  367. signatureAlgorithm: process.env["SHARELATEX_SAML_SIGNATURE_ALGORITHM"]
  368. identifierFormat: process.env["SHARELATEX_SAML_IDENTIFIER_FORMAT"]
  369. attributeConsumingServiceIndex: process.env["SHARELATEX_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX"]
  370. authnContext: process.env["SHARELATEX_SAML_AUTHN_CONTEXT"]
  371. authnRequestBinding: process.env["SHARELATEX_SAML_AUTHN_REQUEST_BINDING"]
  372. validateInResponseTo: process.env["SHARELATEX_SAML_VALIDATE_IN_RESPONSE_TO"]
  373. cacheProvider: process.env["SHARELATEX_SAML_CACHE_PROVIDER"]
  374. logoutUrl: process.env["SHARELATEX_SAML_LOGOUT_URL"]
  375. logoutCallbackUrl: process.env["SHARELATEX_SAML_LOGOUT_CALLBACK_URL"]
  376. disableRequestedAuthnContext: process.env["SHARELATEX_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT"] == 'true'
  377. forceAuthn: process.env["SHARELATEX_SAML_FORCE_AUTHN"] == 'true'
  378. skipRequestCompression: process.env["SHARELATEX_SAML_SKIP_REQUEST_COMPRESSION"] == 'true'
  379. acceptedClockSkewMs: (
  380. if _saml_skew = process.env["SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS"]
  381. try
  382. parseIntOrFail(_saml_skew)
  383. catch e
  384. console.error "Cannot parse SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS"
  385. else
  386. undefined
  387. )
  388. requestIdExpirationPeriodMs: (
  389. if _saml_expiration = process.env["SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS"]
  390. try
  391. parseIntOrFail(_saml_expiration)
  392. catch e
  393. console.error "Cannot parse SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS"
  394. else
  395. undefined
  396. )
  397. additionalParams: (
  398. if _saml_additionalParams = process.env["SHARELATEX_SAML_ADDITIONAL_PARAMS"]
  399. try
  400. JSON.parse(_saml_additionalParams)
  401. catch e
  402. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_PARAMS"
  403. else
  404. undefined
  405. )
  406. additionalAuthorizeParams: (
  407. if _saml_additionalAuthorizeParams = process.env["SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS"]
  408. try
  409. JSON.parse(_saml_additionalAuthorizeParams )
  410. catch e
  411. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS"
  412. else
  413. undefined
  414. )
  415. additionalLogoutParams: (
  416. if _saml_additionalLogoutParams = process.env["SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS"]
  417. try
  418. JSON.parse(_saml_additionalLogoutParams )
  419. catch e
  420. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS"
  421. else
  422. undefined
  423. )
  424. # SHARELATEX_SAML_CERT cannot be empty
  425. # https://github.com/node-saml/passport-saml/commit/f6b1c885c0717f1083c664345556b535f217c102
  426. if process.env["SHARELATEX_SAML_CERT"]
  427. settings.saml.server.cert = process.env["SHARELATEX_SAML_CERT"]
  428. settings.saml.server.privateCert = process.env["SHARELATEX_SAML_PRIVATE_CERT"]
  429. # Compiler
  430. # --------
  431. if process.env["SANDBOXED_COMPILES"] == "true"
  432. settings.clsi =
  433. dockerRunner: true
  434. docker:
  435. image: process.env["TEX_LIVE_DOCKER_IMAGE"]
  436. env:
  437. HOME: "/tmp"
  438. PATH: process.env["COMPILER_PATH"] or "/usr/local/texlive/2015/bin/x86_64-linux:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
  439. user: "www-data"
  440. if !settings.path?
  441. settings.path = {}
  442. settings.path.synctexBaseDir = () -> "/compile"
  443. if process.env['SANDBOXED_COMPILES_SIBLING_CONTAINERS'] == 'true'
  444. console.log("Using sibling containers for sandboxed compiles")
  445. if process.env['SANDBOXED_COMPILES_HOST_DIR']
  446. settings.path.sandboxedCompilesHostDir = process.env['SANDBOXED_COMPILES_HOST_DIR']
  447. else
  448. console.error('Sibling containers, but SANDBOXED_COMPILES_HOST_DIR not set')
  449. # Templates
  450. # ---------
  451. if process.env["SHARELATEX_TEMPLATES_USER_ID"]
  452. settings.templates =
  453. mountPointUrl: "/templates"
  454. user_id: process.env["SHARELATEX_TEMPLATES_USER_ID"]
  455. settings.templateLinks = parse(process.env["SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS"])
  456. # /Learn
  457. # -------
  458. if process.env["SHARELATEX_PROXY_LEARN"]?
  459. settings.proxyLearn = parse(process.env["SHARELATEX_PROXY_LEARN"])
  460. # /References
  461. # -----------
  462. if process.env["SHARELATEX_ELASTICSEARCH_URL"]?
  463. settings.references.elasticsearch =
  464. host: process.env["SHARELATEX_ELASTICSEARCH_URL"]
  465. # TeX Live Images
  466. # -----------
  467. if process.env["ALL_TEX_LIVE_DOCKER_IMAGES"]?
  468. allTexLiveDockerImages = process.env["ALL_TEX_LIVE_DOCKER_IMAGES"].split(',')
  469. if process.env["ALL_TEX_LIVE_DOCKER_IMAGE_NAMES"]?
  470. allTexLiveDockerImageNames = process.env["ALL_TEX_LIVE_DOCKER_IMAGE_NAMES"].split(',')
  471. if allTexLiveDockerImages?
  472. settings.allowedImageNames = []
  473. for fullImageName, index in allTexLiveDockerImages
  474. imageName = Path.basename(fullImageName)
  475. imageDesc = if allTexLiveDockerImageNames? then allTexLiveDockerImageNames[index] else imageName
  476. settings.allowedImageNames.push({ imageName, imageDesc })
  477. # With lots of incoming and outgoing HTTP connections to different services,
  478. # sometimes long running, it is a good idea to increase the default number
  479. # of sockets that Node will hold open.
  480. http = require('http')
  481. http.globalAgent.maxSockets = 300
  482. https = require('https')
  483. https.globalAgent.maxSockets = 300
  484. module.exports = settings