settings.coffee 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655
  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 = "CRYPTO_RANDOM" # Randomly generated for you
  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. console.error "problem parsing #{option}, invalid JSON"
  15. return undefined
  16. DATA_DIR = '/var/lib/sharelatex/data'
  17. TMP_DIR = '/var/lib/sharelatex/tmp'
  18. settings =
  19. # Databases
  20. # ---------
  21. # ShareLaTeX's main persistant data store is MongoDB (http://www.mongodb.org/)
  22. # Documentation about the URL connection string format can be found at:
  23. #
  24. # http://docs.mongodb.org/manual/reference/connection-string/
  25. #
  26. # The following works out of the box with Mongo's default settings:
  27. mongo:
  28. url : process.env["SHARELATEX_MONGO_URL"] or 'mongodb://dockerhost/sharelatex'
  29. # Redis is used in ShareLaTeX for high volume queries, like real-time
  30. # editing, and session management.
  31. #
  32. # The following config will work with Redis's default settings:
  33. redis:
  34. web: redisConfig =
  35. host: process.env["SHARELATEX_REDIS_HOST"] or "dockerhost"
  36. port: process.env["SHARELATEX_REDIS_PORT"] or "6379"
  37. password: process.env["SHARELATEX_REDIS_PASS"] or ""
  38. fairy: redisConfig
  39. documentupdater: [{
  40. primary: true
  41. port: process.env["SHARELATEX_REDIS_PORT"] or "6379"
  42. host: process.env["SHARELATEX_REDIS_HOST"] or "dockerhost"
  43. password: process.env["SHARELATEX_REDIS_PASS"] or ""
  44. key_schema:
  45. blockingKey: ({doc_id}) -> "Blocking:#{doc_id}"
  46. docLines: ({doc_id}) -> "doclines:#{doc_id}"
  47. docOps: ({doc_id}) -> "DocOps:#{doc_id}"
  48. docVersion: ({doc_id}) -> "DocVersion:#{doc_id}"
  49. docHash: ({doc_id}) -> "DocHash:#{doc_id}"
  50. projectKey: ({doc_id}) -> "ProjectId:#{doc_id}"
  51. docsInProject: ({project_id}) -> "DocsIn:#{project_id}"
  52. ranges: ({doc_id}) -> "Ranges:#{doc_id}"
  53. }]
  54. # The compile server (the clsi) uses a SQL database to cache files and
  55. # meta-data. sqllite is the default, and the load is low enough that this will
  56. # be fine in production (we use sqllite at sharelatex.com).
  57. #
  58. # If you want to configure a different database, see the Sequelize documentation
  59. # for available options:
  60. #
  61. # https://github.com/sequelize/sequelize/wiki/API-Reference-Sequelize#example-usage
  62. #
  63. mysql:
  64. clsi:
  65. database: "clsi"
  66. username: "clsi"
  67. password: ""
  68. dialect: "sqlite"
  69. storage: Path.join(DATA_DIR, "db.sqlite")
  70. # File storage
  71. # ------------
  72. # ShareLaTeX can store binary files like images either locally or in Amazon
  73. # S3. The default is locally:
  74. filestore:
  75. backend: "fs"
  76. stores:
  77. user_files: Path.join(DATA_DIR, "user_files")
  78. template_files: Path.join(DATA_DIR, "template_files")
  79. # To use Amazon S3 as a storage backend, comment out the above config, and
  80. # uncomment the following, filling in your key, secret, and bucket name:
  81. #
  82. # filestore:
  83. # backend: "s3"
  84. # stores:
  85. # user_files: "BUCKET_NAME"
  86. # s3:
  87. # key: "AWS_KEY"
  88. # secret: "AWS_SECRET"
  89. #
  90. # Local disk caching
  91. # ------------------
  92. path:
  93. # If we ever need to write something to disk (e.g. incoming requests
  94. # that need processing but may be too big for memory), then write
  95. # them to disk here:
  96. dumpFolder: Path.join(TMP_DIR, "dumpFolder")
  97. # Where to write uploads before they are processed
  98. uploadFolder: Path.join(TMP_DIR, "uploads")
  99. # Where to write the project to disk before running LaTeX on it
  100. compilesDir: Path.join(DATA_DIR, "compiles")
  101. # Where to cache downloaded URLs for the CLSI
  102. clsiCacheDir: Path.join(DATA_DIR, "cache")
  103. # Server Config
  104. # -------------
  105. # Where your instance of ShareLaTeX can be found publicly. This is used
  106. # when emails are sent out and in generated links:
  107. siteUrl: siteUrl = process.env["SHARELATEX_SITE_URL"] or 'http://localhost'
  108. # The name this is used to describe your ShareLaTeX Installation
  109. appName: process.env["SHARELATEX_APP_NAME"] or "ShareLaTeX (Community Edition)"
  110. restrictInvitesToExistingAccounts: process.env["SHARELATEX_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS"] == 'true'
  111. nav:
  112. title: process.env["SHARELATEX_NAV_TITLE"] or process.env["SHARELATEX_APP_NAME"] or "ShareLaTeX Community Edition"
  113. # The email address which users will be directed to as the main point of
  114. # contact for this installation of ShareLaTeX.
  115. adminEmail: process.env["SHARELATEX_ADMIN_EMAIL"] or "placeholder@example.com"
  116. # If provided, a sessionSecret is used to sign cookies so that they cannot be
  117. # spoofed. This is recommended.
  118. security:
  119. sessionSecret: process.env["SHARELATEX_SESSION_SECRET"] or "CRYPTO_RANDOM" # This was randomly generated for you
  120. # These credentials are used for authenticating api requests
  121. # between services that may need to go over public channels
  122. httpAuthUsers: httpAuthUsers
  123. # Should javascript assets be served minified or not. Note that you will
  124. # need to run `grunt compile:minify` within the web-sharelatex directory
  125. # to generate these.
  126. useMinifiedJs: true
  127. # Should static assets be sent with a header to tell the browser to cache
  128. # them. This should be false in development where changes are being made,
  129. # but should be set to true in production.
  130. cacheStaticAssets: true
  131. # If you are running ShareLaTeX over https, set this to true to send the
  132. # cookie with a secure flag (recommended).
  133. secureCookie: process.env["SHARELATEX_SECURE_COOKIE"]?
  134. # If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  135. # then set this to true to allow it to correctly detect the forwarded IP
  136. # address and http/https protocol information.
  137. behindProxy: process.env["SHARELATEX_BEHIND_PROXY"] or false
  138. i18n:
  139. subdomainLang:
  140. www: {lngCode:process.env["SHARELATEX_SITE_LANGUAGE"] or "en", url: siteUrl}
  141. defaultLng: process.env["SHARELATEX_SITE_LANGUAGE"] or "en"
  142. # Spell Check Languages
  143. # ---------------------
  144. #
  145. # You must have the corresponding aspell dictionary installed to
  146. # be able to use a language. Run `grunt check:aspell` to check which
  147. # dictionaries you have installed. These should be set for the `code` for
  148. # each language.
  149. languages: [{
  150. "code":"en", "name":"English (American)"
  151. },{
  152. "code":"en_GB", "name":"English (British)"
  153. },{
  154. "code":"af", "name":"Africaans"
  155. },{
  156. "code":"am", "name":"Amharic"
  157. },{
  158. "code":"ar", "name":"Arabic"
  159. },{
  160. "code":"hy", "name":"Armenian"
  161. },{
  162. "code":"gl", "name":"Galician"
  163. },{
  164. "code":"eu", "name":"Basque"
  165. },{
  166. "code":"bn", "name":"Bengali"
  167. },{
  168. "code":"br", "name":"Breton"
  169. },{
  170. "code":"bg", "name":"Bulgarian"
  171. },{
  172. "code":"ca", "name":"Catalan"
  173. },{
  174. "code":"hr", "name":"Croatian"
  175. },{
  176. "code":"cs", "name":"Czech"
  177. },{
  178. "code":"da", "name":"Danish"
  179. },{
  180. "code":"nl", "name":"Dutch"
  181. },{
  182. "code":"eo", "name":"Esperanto"
  183. },{
  184. "code":"et", "name":"Estonian"
  185. },{
  186. "code":"fo", "name":"Faroese"
  187. },{
  188. "code":"fr", "name":"French"
  189. },{
  190. "code":"de", "name":"German"
  191. },{
  192. "code":"el", "name":"Greek"
  193. },{
  194. "code":"gu", "name":"Gujarati"
  195. },{
  196. "code":"he", "name":"Hebrew"
  197. },{
  198. "code":"hi", "name":"Hindi"
  199. },{
  200. "code":"hu", "name":"Hungarian"
  201. },{
  202. "code":"is", "name":"Icelandic"
  203. },{
  204. "code":"id", "name":"Indonesian"
  205. },{
  206. "code":"ga", "name":"Irish"
  207. },{
  208. "code":"it", "name":"Italian"
  209. },{
  210. "code":"kn", "name":"Kannada"
  211. },{
  212. "code":"kk", "name":"Kazakh"
  213. },{
  214. "code":"ku", "name":"Kurdish"
  215. },{
  216. "code":"lv", "name":"Latvian"
  217. },{
  218. "code":"lt", "name":"Lithuanian"
  219. },{
  220. "code":"ml", "name":"Malayalam"
  221. },{
  222. "code":"mr", "name":"Marathi"
  223. },{
  224. "code":"nr", "name":"Ndebele"
  225. },{
  226. "code":"ns", "name":"Northern Sotho"
  227. },{
  228. "code":"no", "name":"Norwegian"
  229. },{
  230. "code":"or", "name":"Oriya"
  231. },{
  232. "code":"fa", "name":"Persian"
  233. },{
  234. "code":"pl", "name":"Polish"
  235. },{
  236. "code":"pt_BR", "name":"Portuguese (Brazilian)"
  237. },{
  238. "code":"pt_PT", "name":"Portuguese (European)"
  239. },{
  240. "code":"pa", "name":"Punjabi"
  241. },{
  242. "code":"ro", "name":"Romanian"
  243. },{
  244. "code":"ru", "name":"Russian"
  245. },{
  246. "code":"sk", "name":"Slovak"
  247. },{
  248. "code":"sl", "name":"Slovenian"
  249. },{
  250. "code":"st", "name":"Southern Sotho"
  251. },{
  252. "code":"es", "name":"Spanish"
  253. },{
  254. "code":"ss", "name":"Swazi"
  255. },{
  256. "code":"sv", "name":"Swedish"
  257. },{
  258. "code":"tl", "name":"Tagalog"
  259. },{
  260. "code":"ta", "name":"Tamil"
  261. },{
  262. "code":"te", "name":"Telugu"
  263. },{
  264. "code":"ts", "name":"Tsonga"
  265. },{
  266. "code":"tn", "name":"Tswana"
  267. },{
  268. "code":"uk", "name":"Ukrainian"
  269. },{
  270. "code":"hsb", "name":"Upper Sorbian"
  271. },{
  272. "code":"uz", "name":"Uzbek"
  273. },{
  274. "code":"cy", "name":"Welsh"
  275. },{
  276. "code":"xh", "name":"Xhosa"
  277. },{
  278. "code":"zu", "name":"Zulu"
  279. }
  280. ]
  281. apis:
  282. web:
  283. url: "http://localhost:3000"
  284. user: httpAuthUser
  285. pass: httpAuthPass
  286. references:{}
  287. notifications:undefined
  288. defaultFeatures:
  289. collaborators: -1
  290. dropbox: true
  291. versioning: true
  292. compileTimeout: 180
  293. compileGroup: "standard"
  294. references: true
  295. templates: true
  296. ## OPTIONAL CONFIGERABLE SETTINGS
  297. if process.env["SHARELATEX_LEFT_FOOTER"]?
  298. try
  299. settings.nav.left_footer = JSON.parse(process.env["SHARELATEX_LEFT_FOOTER"])
  300. catch e
  301. console.error("could not parse SHARELATEX_LEFT_FOOTER, not valid JSON")
  302. if process.env["SHARELATEX_RIGHT_FOOTER"]?
  303. settings.nav.right_footer = process.env["SHARELATEX_RIGHT_FOOTER"]
  304. try
  305. settings.nav.right_footer = JSON.parse(process.env["SHARELATEX_RIGHT_FOOTER"])
  306. catch e
  307. console.error("could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON")
  308. if process.env["SHARELATEX_HEADER_IMAGE_URL"]?
  309. settings.nav.custom_logo = process.env["SHARELATEX_HEADER_IMAGE_URL"]
  310. if process.env["SHARELATEX_HEADER_NAV_LINKS"]?
  311. console.error """
  312. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  313. #
  314. # WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported
  315. # See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo
  316. #
  317. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  318. """
  319. if process.env["SHARELATEX_HEADER_EXTRAS"]?
  320. try
  321. settings.nav.header_extras = JSON.parse(process.env["SHARELATEX_HEADER_EXTRAS"])
  322. catch e
  323. console.error("could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON")
  324. # Sending Email
  325. # -------------
  326. #
  327. # You must configure a mail server to be able to send invite emails from
  328. # ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer
  329. # documentation for available options:
  330. #
  331. # http://www.nodemailer.com/docs/transports
  332. if process.env["SHARELATEX_EMAIL_FROM_ADDRESS"]?
  333. settings.email =
  334. fromAddress: process.env["SHARELATEX_EMAIL_FROM_ADDRESS"]
  335. replyTo: process.env["SHARELATEX_EMAIL_REPLY_TO"] or ""
  336. parameters:
  337. #AWS Creds
  338. AWSAccessKeyID: process.env["SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID"]
  339. AWSSecretKey: process.env["SHARELATEX_EMAIL_AWS_SES_SECRET_KEY"]
  340. #SMTP Creds
  341. host: process.env["SHARELATEX_EMAIL_SMTP_HOST"]
  342. port: process.env["SHARELATEX_EMAIL_SMTP_PORT"],
  343. secure: parse(process.env["SHARELATEX_EMAIL_SMTP_SECURE"])
  344. ignoreTLS: parse(process.env["SHARELATEX_EMAIL_SMTP_IGNORE_TLS"])
  345. textEncoding: process.env["SHARELATEX_EMAIL_TEXT_ENCODING"]
  346. templates:
  347. customFooter: process.env["SHARELATEX_CUSTOM_EMAIL_FOOTER"]
  348. if process.env["SHARELATEX_EMAIL_SMTP_USER"]? or process.env["SHARELATEX_EMAIL_SMTP_PASS"]?
  349. settings.email.parameters.auth =
  350. user: process.env["SHARELATEX_EMAIL_SMTP_USER"]
  351. pass: process.env["SHARELATEX_EMAIL_SMTP_PASS"]
  352. if process.env["SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH"]?
  353. settings.email.parameters.tls =
  354. rejectUnauthorized: parse(process.env["SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH"])
  355. # i18n
  356. if process.env["SHARELATEX_LANG_DOMAIN_MAPPING"]?
  357. settings.i18n.subdomainLang = parse(process.env["SHARELATEX_LANG_DOMAIN_MAPPING"])
  358. # Password Settings
  359. # -----------
  360. # These restrict the passwords users can use when registering
  361. # opts are from http://antelle.github.io/passfield
  362. if process.env["SHARELATEX_PASSWORD_VALIDATION_PATTERN"] or process.env["SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH"] or process.env["SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH"]
  363. settings.passwordStrengthOptions =
  364. pattern: process.env["SHARELATEX_PASSWORD_VALIDATION_PATTERN"] or "aA$3"
  365. length: {min:process.env["SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH"] or 8, max: process.env["SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH"] or 150}
  366. #######################
  367. # ShareLaTeX Server Pro
  368. #######################
  369. if parse(process.env["SHARELATEX_IS_SERVER_PRO"]) == true
  370. settings.apis.references =
  371. url: "http://localhost:3040"
  372. # LDAP - SERVER PRO ONLY
  373. # ----------
  374. if process.env["SHARELATEX_LDAP_HOST"]
  375. console.error """
  376. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  377. #
  378. # WARNING: The LDAP configuration format has changed in version 0.5.1
  379. # See https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-LDAP-Config
  380. #
  381. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  382. """
  383. if process.env["SHARELATEX_LDAP_URL"]
  384. settings.externalAuth = true
  385. settings.ldap =
  386. emailAtt: process.env["SHARELATEX_LDAP_EMAIL_ATT"]
  387. nameAtt: process.env["SHARELATEX_LDAP_NAME_ATT"]
  388. lastNameAtt: process.env["SHARELATEX_LDAP_LAST_NAME_ATT"]
  389. updateUserDetailsOnLogin: 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: (
  400. if _ldap_search_attribs = process.env["SHARELATEX_LDAP_SEARCH_ATTRIBUTES"]
  401. try
  402. JSON.parse(_ldap_search_attribs)
  403. catch e
  404. console.error "could not parse SHARELATEX_LDAP_SEARCH_ATTRIBUTES"
  405. else
  406. undefined
  407. )
  408. groupDnProperty: process.env["SHARELATEX_LDAP_GROUP_DN_PROPERTY"]
  409. groupSearchBase: process.env["SHARELATEX_LDAP_GROUP_SEARCH_BASE"]
  410. groupSearchScope: process.env["SHARELATEX_LDAP_GROUP_SEARCH_SCOPE"]
  411. groupSearchFilter: process.env["SHARELATEX_LDAP_GROUP_SEARCH_FILTER"]
  412. groupSearchAttributes: (
  413. if _ldap_group_search_attribs = process.env["SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES"]
  414. try
  415. JSON.parse(_ldap_group_search_attribs)
  416. catch e
  417. console.error "could not parse SHARELATEX_LDAP_GROUP_SEARCH_ATTRIBUTES"
  418. else
  419. undefined
  420. )
  421. cache: process.env["SHARELATEX_LDAP_CACHE"] == 'true'
  422. timeout: (
  423. if _ldap_timeout = process.env["SHARELATEX_LDAP_TIMEOUT"]
  424. try
  425. parseInt(_ldap_timeout)
  426. catch e
  427. console.error "Cannot parse SHARELATEX_LDAP_TIMEOUT"
  428. else
  429. undefined
  430. )
  431. connectTimeout: (
  432. if _ldap_connect_timeout = process.env["SHARELATEX_LDAP_CONNECT_TIMEOUT"]
  433. try
  434. parseInt(_ldap_connect_timeout)
  435. catch e
  436. console.error "Cannot parse SHARELATEX_LDAP_CONNECT_TIMEOUT"
  437. else
  438. undefined
  439. )
  440. if process.env["SHARELATEX_LDAP_TLS_OPTS_CA_PATH"]
  441. try
  442. ca = JSON.parse(process.env["SHARELATEX_LDAP_TLS_OPTS_CA_PATH"])
  443. catch e
  444. console.error "could not parse SHARELATEX_LDAP_TLS_OPTS_CA_PATH, invalid JSON"
  445. if typeof(ca) == 'string'
  446. ca_paths = [ca]
  447. else if typeof(ca) == 'object' && ca?.length?
  448. ca_paths = ca
  449. else
  450. console.error "problem parsing SHARELATEX_LDAP_TLS_OPTS_CA_PATH"
  451. settings.ldap.server.tlsOptions =
  452. rejectUnauthorized: process.env["SHARELATEX_LDAP_TLS_OPTS_REJECT_UNAUTH"] == "true"
  453. ca:ca_paths # e.g.'/etc/ldap/ca_certs.pem'
  454. if process.env["SHARELATEX_SAML_ENTRYPOINT"]
  455. # NOTE: see https://github.com/bergie/passport-saml/blob/master/README.md for docs of `server` options
  456. settings.externalAuth = true
  457. settings.saml =
  458. updateUserDetailsOnLogin: process.env["SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN"] == 'true'
  459. identityServiceName: process.env["SHARELATEX_SAML_IDENTITY_SERVICE_NAME"]
  460. emailField: process.env["SHARELATEX_SAML_EMAIL_FIELD"] || process.env["SHARELATEX_SAML_EMAIL_FIELD_NAME"]
  461. firstNameField: process.env["SHARELATEX_SAML_FIRST_NAME_FIELD"]
  462. lastNameField: process.env["SHARELATEX_SAML_LAST_NAME_FIELD"]
  463. server:
  464. # strings
  465. entryPoint: process.env["SHARELATEX_SAML_ENTRYPOINT"]
  466. callbackUrl: process.env["SHARELATEX_SAML_CALLBACK_URL"]
  467. issuer: process.env["SHARELATEX_SAML_ISSUER"]
  468. cert: process.env["SHARELATEX_SAML_CERT"]
  469. privateCert: process.env["SHARELATEX_SAML_PRIVATE_CERT"]
  470. decryptionPvk: process.env["SHARELATEX_SAML_DECRYPTION_PVK"]
  471. signatureAlgorithm: process.env["SHARELATEX_SAML_SIGNATURE_ALGORITHM"]
  472. identifierFormat: process.env["SHARELATEX_SAML_IDENTIFIER_FORMAT"]
  473. attributeConsumingServiceIndex: process.env["SHARELATEX_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX"]
  474. authnContext: process.env["SHARELATEX_SAML_AUTHN_CONTEXT"]
  475. authnRequestBinding: process.env["SHARELATEX_SAML_AUTHN_REQUEST_BINDING"]
  476. validateInResponseTo: process.env["SHARELATEX_SAML_VALIDATE_IN_RESPONSE_TO"]
  477. cacheProvider: process.env["SHARELATEX_SAML_CACHE_PROVIDER"]
  478. logoutUrl: process.env["SHARELATEX_SAML_LOGOUT_URL"]
  479. logoutCallbackUrl: process.env["SHARELATEX_SAML_LOGOUT_CALLBACK_URL"]
  480. disableRequestedAuthnContext: process.env["SHARELATEX_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT"] == 'true'
  481. forceAuthn: process.env["SHARELATEX_SAML_FORCE_AUTHN"] == 'true'
  482. skipRequestCompression: process.env["SHARELATEX_SAML_SKIP_REQUEST_COMPRESSION"] == 'true'
  483. acceptedClockSkewMs: (
  484. if _saml_skew = process.env["SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS"]
  485. try
  486. parseInt(_saml_skew)
  487. catch e
  488. console.error "Cannot parse SHARELATEX_SAML_ACCEPTED_CLOCK_SKEW_MS"
  489. else
  490. undefined
  491. )
  492. requestIdExpirationPeriodMs: (
  493. if _saml_exiration = process.env["SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS"]
  494. try
  495. parseInt(_saml_expiration)
  496. catch e
  497. console.error "Cannot parse SHARELATEX_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS"
  498. else
  499. undefined
  500. )
  501. additionalParams: (
  502. if _saml_additionalParams = process.env["SHARELATEX_SAML_ADDITIONAL_PARAMS"]
  503. try
  504. JSON.parse(_saml_additionalParams)
  505. catch e
  506. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_PARAMS"
  507. else
  508. undefined
  509. )
  510. additionalAuthorizeParams: (
  511. if _saml_additionalAuthorizeParams = process.env["SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS"]
  512. try
  513. JSON.parse(_saml_additionalAuthorizeParams )
  514. catch e
  515. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_AUTHORIZE_PARAMS"
  516. else
  517. undefined
  518. )
  519. additionalLogoutParams: (
  520. if _saml_additionalLogoutParams = process.env["SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS"]
  521. try
  522. JSON.parse(_saml_additionalLogoutParams )
  523. catch e
  524. console.error "Cannot parse SHARELATEX_SAML_ADDITIONAL_LOGOUT_PARAMS"
  525. else
  526. undefined
  527. )
  528. # Compiler
  529. # --------
  530. if process.env["SANDBOXED_COMPILES"] == "true"
  531. settings.clsi =
  532. commandRunner: "docker-runner-sharelatex"
  533. docker:
  534. image: process.env["TEX_LIVE_DOCKER_IMAGE"]
  535. env:
  536. HOME: "/tmp"
  537. 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"
  538. user: "www-data"
  539. if !settings.path?
  540. settings.path = {}
  541. settings.path.synctexBaseDir = () -> "/compile"
  542. if process.env['SANDBOXED_COMPILES_SIBLING_CONTAINERS'] == 'true'
  543. console.log("Using sibling containers for sandoxed compiles")
  544. if process.env['SANDBOXED_COMPILES_HOST_DIR']
  545. settings.path.sandboxedCompilesHostDir = process.env['SANDBOXED_COMPILES_HOST_DIR']
  546. else
  547. console.error('Sibling containers, but SANDBOXED_COMPILES_HOST_DIR not set')
  548. # Templates
  549. # ---------
  550. if process.env["SHARELATEX_TEMPLATES_USER_ID"]
  551. settings.templates =
  552. mountPointUrl: "/templates"
  553. user_id: process.env["SHARELATEX_TEMPLATES_USER_ID"]
  554. settings.templateLinks = parse(process.env["SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS"])
  555. # /Learn
  556. # -------
  557. if process.env["SHARELATEX_PROXY_LEARN"]?
  558. settings.proxyLearn = parse(process.env["SHARELATEX_PROXY_LEARN"])
  559. # /References
  560. # -----------
  561. if process.env["SHARELATEX_ELASTICSEARCH_URL"]?
  562. settings.references.elasticsearch =
  563. host: process.env["SHARELATEX_ELASTICSEARCH_URL"]
  564. # With lots of incoming and outgoing HTTP connections to different services,
  565. # sometimes long running, it is a good idea to increase the default number
  566. # of sockets that Node will hold open.
  567. http = require('http')
  568. http.globalAgent.maxSockets = 300
  569. https = require('https')
  570. https.globalAgent.maxSockets = 300
  571. module.exports = settings