settings.coffee 22 KB

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