settings.coffee 22 KB

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