settings.defaults.coffee 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687
  1. Path = require('path')
  2. http = require('http')
  3. http.globalAgent.maxSockets = 300
  4. # Make time interval config easier.
  5. seconds = 1000
  6. minutes = 60 * seconds
  7. # These credentials are used for authenticating api requests
  8. # between services that may need to go over public channels
  9. httpAuthUser = process.env['WEB_API_USER']
  10. httpAuthPass = process.env['WEB_API_PASSWORD']
  11. httpAuthUsers = {}
  12. if httpAuthUser and httpAuthPass
  13. httpAuthUsers[httpAuthUser] = httpAuthPass
  14. sessionSecret = process.env['SESSION_SECRET'] or "secret-please-change"
  15. if process.env['V1_API_URL'] or process.env['V1_HOST']
  16. v1Api =
  17. url: process.env['V1_API_URL'] or "http://#{process.env['V1_HOST']}:5000"
  18. user: process.env['V1_API_USER']
  19. pass: process.env['V1_API_PASSWORD']
  20. else
  21. v1Api =
  22. url: undefined
  23. user: undefined
  24. pass: undefined
  25. intFromEnv = (name, defaultValue) ->
  26. if defaultValue in [null, undefined] or typeof defaultValue != 'number'
  27. throw new Error("Bad default integer value for setting: #{name}, #{defaultValue}")
  28. parseInt(process.env[name], 10) || defaultValue
  29. module.exports = settings =
  30. allowAnonymousReadAndWriteSharing:
  31. process.env['SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING'] == 'true'
  32. # Databases
  33. # ---------
  34. mongo:
  35. options: {
  36. appname: 'web'
  37. useUnifiedTopology: (process.env['MONGO_USE_UNIFIED_TOPOLOGY'] || 'true') == 'true',
  38. poolSize: parseInt(process.env['MONGO_POOL_SIZE'], 10) || 10,
  39. serverSelectionTimeoutMS: parseInt(process.env['MONGO_SERVER_SELECTION_TIMEOUT'], 10) || 60000,
  40. socketTimeoutMS: parseInt(process.env['MONGO_SOCKET_TIMEOUT'], 10) || 30000,
  41. },
  42. url : process.env['MONGO_CONNECTION_STRING'] || process.env['MONGO_URL'] || "mongodb://#{process.env['MONGO_HOST'] or '127.0.0.1'}/sharelatex"
  43. redis:
  44. web:
  45. host: process.env['REDIS_HOST'] || "localhost"
  46. port: process.env['REDIS_PORT'] || "6379"
  47. password: process.env["REDIS_PASSWORD"] or ""
  48. maxRetriesPerRequest: parseInt(process.env["REDIS_MAX_RETRIES_PER_REQUEST"] || '20')
  49. # websessions:
  50. # cluster: [
  51. # {host: 'localhost', port: 7000}
  52. # {host: 'localhost', port: 7001}
  53. # {host: 'localhost', port: 7002}
  54. # {host: 'localhost', port: 7003}
  55. # {host: 'localhost', port: 7004}
  56. # {host: 'localhost', port: 7005}
  57. # ]
  58. # ratelimiter:
  59. # cluster: [
  60. # {host: 'localhost', port: 7000}
  61. # {host: 'localhost', port: 7001}
  62. # {host: 'localhost', port: 7002}
  63. # {host: 'localhost', port: 7003}
  64. # {host: 'localhost', port: 7004}
  65. # {host: 'localhost', port: 7005}
  66. # ]
  67. # cooldown:
  68. # cluster: [
  69. # {host: 'localhost', port: 7000}
  70. # {host: 'localhost', port: 7001}
  71. # {host: 'localhost', port: 7002}
  72. # {host: 'localhost', port: 7003}
  73. # {host: 'localhost', port: 7004}
  74. # {host: 'localhost', port: 7005}
  75. # ]
  76. api:
  77. host: process.env['REDIS_HOST'] || "localhost"
  78. port: process.env['REDIS_PORT'] || "6379"
  79. password: process.env["REDIS_PASSWORD"] or ""
  80. maxRetriesPerRequest: parseInt(process.env["REDIS_MAX_RETRIES_PER_REQUEST"] || '20')
  81. queues:
  82. host: process.env['QUEUES_REDIS_HOST'] || 'localhost'
  83. port: process.env['QUEUES_REDIS_PORT'] || '6379'
  84. password: process.env['QUEUES_REDIS_PASSWORD'] || ''
  85. # Service locations
  86. # -----------------
  87. # Configure which ports to run each service on. Generally you
  88. # can leave these as they are unless you have some other services
  89. # running which conflict, or want to run the web process on port 80.
  90. internal:
  91. web:
  92. port: webPort = process.env['WEB_PORT'] or 3000
  93. host: process.env['LISTEN_ADDRESS'] or 'localhost'
  94. documentupdater:
  95. port: docUpdaterPort = 3003
  96. gitBridgePublicBaseUrl: "http://#{process.env['GIT_BRIDGE_HOST'] || 'localhost'}:8000"
  97. # Tell each service where to find the other services. If everything
  98. # is running locally then this is easy, but they exist as separate config
  99. # options incase you want to run some services on remote hosts.
  100. apis:
  101. web:
  102. url: "http://#{process.env['WEB_API_HOST'] or process.env['WEB_HOST'] or "localhost"}:#{process.env['WEB_API_PORT'] or process.env['WEB_PORT'] or 3000}"
  103. user: httpAuthUser
  104. pass: httpAuthPass
  105. documentupdater:
  106. url : "http://#{process.env['DOCUPDATER_HOST'] or process.env['DOCUMENT_UPDATER_HOST'] or 'localhost'}:#{docUpdaterPort}"
  107. thirdPartyDataStore:
  108. url : "http://#{process.env['TPDS_HOST'] or 'localhost'}:3002"
  109. emptyProjectFlushDelayMiliseconds: 5 * seconds
  110. dropboxApp: process.env['TPDS_DROPBOX_APP']
  111. tags:
  112. url :"http://#{process.env['TAGS_HOST'] or 'localhost'}:3012"
  113. spelling:
  114. url : "http://#{process.env['SPELLING_HOST'] or 'localhost'}:3005"
  115. host: process.env['SPELLING_HOST']
  116. trackchanges:
  117. url : "http://#{process.env['TRACK_CHANGES_HOST'] or 'localhost'}:3015"
  118. project_history:
  119. sendProjectStructureOps: process.env.PROJECT_HISTORY_ENABLED == 'true' or false
  120. initializeHistoryForNewProjects: process.env.PROJECT_HISTORY_ENABLED == 'true' or false
  121. displayHistoryForNewProjects: process.env.PROJECT_HISTORY_ENABLED == 'true' or false
  122. url : "http://#{process.env['PROJECT_HISTORY_HOST'] or 'localhost'}:3054"
  123. docstore:
  124. url : "http://#{process.env['DOCSTORE_HOST'] or 'localhost'}:3016"
  125. pubUrl: "http://#{process.env['DOCSTORE_HOST'] or 'localhost'}:3016"
  126. chat:
  127. url: "http://#{process.env['CHAT_HOST'] or 'localhost'}:3010"
  128. internal_url: "http://#{process.env['CHAT_HOST'] or 'localhost'}:3010"
  129. blog:
  130. url: "http://localhost:3008"
  131. port: 3008
  132. university:
  133. url: "http://localhost:3011"
  134. filestore:
  135. url: "http://#{process.env['FILESTORE_HOST'] or 'localhost'}:3009"
  136. clsi:
  137. url: "http://#{process.env['CLSI_HOST'] or 'localhost'}:3013"
  138. # url: "http://#{process.env['CLSI_LB_HOST']}:3014"
  139. backendGroupName: undefined
  140. templates:
  141. url: "http://#{process.env['TEMPLATES_HOST'] or 'localhost'}:3007"
  142. githubSync:
  143. url: "http://#{process.env['GITHUB_SYNC_HOST'] or 'localhost'}:3022"
  144. recurly:
  145. apiKey: process.env['RECURLY_API_KEY'] or ''
  146. apiVersion: process.env['RECURLY_API_VERSION']
  147. subdomain: process.env['RECURLY_SUBDOMAIN'] or ''
  148. publicKey: process.env['RECURLY_PUBLIC_KEY'] or ''
  149. geoIpLookup:
  150. url: "http://#{process.env['GEOIP_HOST'] or process.env['FREEGEOIP_HOST'] or 'localhost'}:8080/json/"
  151. realTime:
  152. url: "http://#{process.env['REALTIME_HOST'] or 'localhost'}:3026"
  153. contacts:
  154. url: "http://#{process.env['CONTACTS_HOST'] or 'localhost'}:3036"
  155. sixpack:
  156. url: ""
  157. references:
  158. url: if process.env['REFERENCES_HOST']? then "http://#{process.env['REFERENCES_HOST']}:3040" else undefined
  159. notifications:
  160. url: "http://#{process.env['NOTIFICATIONS_HOST'] or 'localhost'}:3042"
  161. analytics:
  162. url: "http://#{process.env['ANALYTICS_HOST'] or 'localhost'}:3050"
  163. linkedUrlProxy:
  164. url: process.env['LINKED_URL_PROXY']
  165. thirdpartyreferences:
  166. url: "http://#{process.env['THIRD_PARTY_REFERENCES_HOST'] or 'localhost'}:3046"
  167. timeout: parseInt(process.env['THIRD_PARTY_REFERENCES_TIMEOUT'] || '30000', 10)
  168. v1:
  169. url: v1Api.url
  170. user: v1Api.user
  171. pass: v1Api.pass
  172. v1_history:
  173. url: "http://#{process.env['V1_HISTORY_HOST'] or "localhost"}:3100/api"
  174. user: process.env['V1_HISTORY_USER'] or 'staging'
  175. pass: process.env['V1_HISTORY_PASSWORD'] or 'password'
  176. templates:
  177. user_id: process.env.TEMPLATES_USER_ID or "5395eb7aad1f29a88756c7f2"
  178. showSocialButtons: false
  179. showComments: false
  180. # cdn:
  181. # web:
  182. # host:"http://nowhere.sharelatex.dev"
  183. # darkHost:"http://cdn.sharelatex.dev:3000"
  184. # Where your instance of ShareLaTeX can be found publically. Used in emails
  185. # that are sent out, generated links, etc.
  186. siteUrl : siteUrl = process.env['PUBLIC_URL'] or 'http://localhost:3000'
  187. lockManager:
  188. lockTestInterval: intFromEnv('LOCK_MANAGER_LOCK_TEST_INTERVAL', 50)
  189. maxTestInterval: intFromEnv('LOCK_MANAGER_MAX_TEST_INTERVAL', 1000)
  190. maxLockWaitTime: intFromEnv('LOCK_MANAGER_MAX_LOCK_WAIT_TIME', 10000)
  191. redisLockExpiry: intFromEnv('LOCK_MANAGER_REDIS_LOCK_EXPIRY', 30)
  192. slowExecutionThreshold: intFromEnv('LOCK_MANAGER_SLOW_EXECUTION_THRESHOLD', 5000)
  193. # Used to close the editor off to users
  194. editorIsOpen: process.env['EDITOR_IS_OPEN'] or true
  195. # Optional separate location for websocket connections, if unset defaults to siteUrl.
  196. wsUrl: process.env['WEBSOCKET_URL']
  197. wsUrlV2: process.env['WEBSOCKET_URL_V2']
  198. wsUrlBeta: process.env['WEBSOCKET_URL_BETA']
  199. wsUrlV2Percentage: parseInt(process.env['WEBSOCKET_URL_V2_PERCENTAGE'] || '0', 10)
  200. wsRetryHandshake: parseInt(process.env['WEBSOCKET_RETRY_HANDSHAKE'] || '5', 10)
  201. # Compile UI rollout percentages
  202. logsUIPercentageBeta: parseInt(process.env['LOGS_UI_PERCENTAGE_BETA'] || '0', 10)
  203. logsUIPercentage: parseInt(process.env['LOGS_UI_PERCENTAGE'] || '0', 10)
  204. # cookie domain
  205. # use full domain for cookies to only be accessible from that domain,
  206. # replace subdomain with dot to have them accessible on all subdomains
  207. cookieDomain: process.env['COOKIE_DOMAIN']
  208. cookieName: process.env['COOKIE_NAME'] or "sharelatex.sid"
  209. # this is only used if cookies are used for clsi backend
  210. #clsiCookieKey: "clsiserver"
  211. # Same, but with http auth credentials.
  212. httpAuthSiteUrl: "http://#{httpAuthUser}:#{httpAuthPass}@#{siteUrl}"
  213. robotsNoindex: (process.env['ROBOTS_NOINDEX'] == "true") or false
  214. maxEntitiesPerProject: 2000
  215. maxUploadSize: 50 * 1024 * 1024 # 50 MB
  216. # start failing the health check if active handles exceeds this limit
  217. maxActiveHandles: if process.env['MAX_ACTIVE_HANDLES'] then parseInt(process.env['MAX_ACTIVE_HANDLES'], 10)
  218. # Security
  219. # --------
  220. security:
  221. sessionSecret: sessionSecret
  222. bcryptRounds: (parseInt(process.env['BCRYPT_ROUNDS'], 10) || 12) # number of rounds used to hash user passwords (raised to power 2)
  223. httpAuthUsers: httpAuthUsers
  224. twoFactorAuthentication:
  225. enabled: process.env['TWO_FACTOR_AUTHENTICATION_ENABLED'] == 'true'
  226. requiredForStaff: process.env['TWO_FACTOR_AUTHENTICATION_REQUIRED_FOR_STAFF'] == 'true'
  227. jwt:
  228. key: process.env['OT_JWT_AUTH_KEY']
  229. algorithm: process.env['OT_JWT_AUTH_ALG'] || 'HS256'
  230. # Default features
  231. # ----------------
  232. #
  233. # You can select the features that are enabled by default for new
  234. # new users.
  235. defaultFeatures: defaultFeatures =
  236. collaborators: -1
  237. dropbox: true
  238. github: true
  239. gitBridge: true
  240. versioning: true
  241. compileTimeout: 180
  242. compileGroup: "standard"
  243. references: true
  244. templates: true
  245. trackChanges: true
  246. features:
  247. personal: defaultFeatures
  248. plans: plans = [{
  249. planCode: "personal"
  250. name: "Personal"
  251. price: 0
  252. features: defaultFeatures
  253. }]
  254. enableSubscriptions:false
  255. enabledLinkedFileTypes: (process.env['ENABLED_LINKED_FILE_TYPES'] or '').split(',')
  256. # i18n
  257. # ------
  258. #
  259. i18n:
  260. checkForHTMLInVars: process.env['I18N_CHECK_FOR_HTML_IN_VARS'] == 'true'
  261. escapeHTMLInVars: process.env['I18N_ESCAPE_HTML_IN_VARS'] == 'true'
  262. subdomainLang:
  263. www: {lngCode:"en", url: siteUrl}
  264. defaultLng: "en"
  265. # Spelling languages
  266. # ------------------
  267. #
  268. # You must have the corresponding aspell package installed to
  269. # be able to use a language.
  270. languages: [
  271. {code: "en", name: "English"},
  272. {code: "en_US", name: "English (American)"},
  273. {code: "en_GB", name: "English (British)"},
  274. {code: "en_CA", name: "English (Canadian)"},
  275. {code: "af", name: "Afrikaans"},
  276. {code: "ar", name: "Arabic"},
  277. {code: "gl", name: "Galician"},
  278. {code: "eu", name: "Basque"},
  279. {code: "br", name: "Breton"},
  280. {code: "bg", name: "Bulgarian"},
  281. {code: "ca", name: "Catalan"},
  282. {code: "hr", name: "Croatian"},
  283. {code: "cs", name: "Czech"},
  284. {code: "da", name: "Danish"},
  285. {code: "nl", name: "Dutch"},
  286. {code: "eo", name: "Esperanto"},
  287. {code: "et", name: "Estonian"},
  288. {code: "fo", name: "Faroese"},
  289. {code: "fr", name: "French"},
  290. {code: "de", name: "German"},
  291. {code: "el", name: "Greek"},
  292. {code: "id", name: "Indonesian"},
  293. {code: "ga", name: "Irish"},
  294. {code: "it", name: "Italian"},
  295. {code: "kk", name: "Kazakh"},
  296. {code: "ku", name: "Kurdish"},
  297. {code: "lv", name: "Latvian"},
  298. {code: "lt", name: "Lithuanian"},
  299. {code: "nr", name: "Ndebele"},
  300. {code: "ns", name: "Northern Sotho"},
  301. {code: "no", name: "Norwegian"},
  302. {code: "fa", name: "Persian"},
  303. {code: "pl", name: "Polish"},
  304. {code: "pt_BR", name: "Portuguese (Brazilian)"},
  305. {code: "pt_PT", name: "Portuguese (European)"},
  306. {code: "pa", name: "Punjabi"},
  307. {code: "ro", name: "Romanian"},
  308. {code: "ru", name: "Russian"},
  309. {code: "sk", name: "Slovak"},
  310. {code: "sl", name: "Slovenian"},
  311. {code: "st", name: "Southern Sotho"},
  312. {code: "es", name: "Spanish"},
  313. {code: "sv", name: "Swedish"},
  314. {code: "tl", name: "Tagalog"},
  315. {code: "ts", name: "Tsonga"},
  316. {code: "tn", name: "Tswana"},
  317. {code: "hsb", name: "Upper Sorbian"},
  318. {code: "cy", name: "Welsh"},
  319. {code: "xh", name: "Xhosa"}
  320. ]
  321. # Password Settings
  322. # -----------
  323. # These restrict the passwords users can use when registering
  324. # opts are from http://antelle.github.io/passfield
  325. # passwordStrengthOptions:
  326. # pattern: "aA$3"
  327. # length:
  328. # min: 6
  329. # max: 128
  330. # Email support
  331. # -------------
  332. #
  333. # ShareLaTeX uses nodemailer (http://www.nodemailer.com/) to send transactional emails.
  334. # To see the range of transport and options they support, see http://www.nodemailer.com/docs/transports
  335. #email:
  336. # fromAddress: ""
  337. # replyTo: ""
  338. # lifecycle: false
  339. ## Example transport and parameter settings for Amazon SES
  340. # transport: "SES"
  341. # parameters:
  342. # AWSAccessKeyID: ""
  343. # AWSSecretKey: ""
  344. # Third party services
  345. # --------------------
  346. #
  347. # ShareLaTeX's regular newsletter is managed by mailchimp. Add your
  348. # credentials here to integrate with this.
  349. # mailchimp:
  350. # api_key: ""
  351. # list_id: ""
  352. #
  353. # Fill in your unique token from various analytics services to enable
  354. # them.
  355. # analytics:
  356. # ga:
  357. # token: ""
  358. # gaOptimize:
  359. # id: ""
  360. # ShareLaTeX's help desk is provided by tenderapp.com
  361. # tenderUrl: ""
  362. #
  363. # Client-side error logging is provided by getsentry.com
  364. sentry:
  365. environment: process.env['SENTRY_ENVIRONMENT']
  366. release: process.env['SENTRY_RELEASE']
  367. # publicDSN: ""
  368. # The publicDSN is the token for the client-side getSentry service.
  369. # Production Settings
  370. # -------------------
  371. debugPugTemplates: process.env['DEBUG_PUG_TEMPLATES'] == 'true'
  372. # Should javascript assets be served minified or not. Note that you will
  373. # need to run `grunt compile:minify` within the web-sharelatex directory
  374. # to generate these.
  375. useMinifiedJs: process.env['MINIFIED_JS'] == 'true' or false
  376. # Should static assets be sent with a header to tell the browser to cache
  377. # them.
  378. cacheStaticAssets: false
  379. # If you are running ShareLaTeX over https, set this to true to send the
  380. # cookie with a secure flag (recommended).
  381. secureCookie: false
  382. # 'SameSite' cookie setting. Can be set to 'lax', 'none' or 'strict'
  383. # 'lax' is recommended, as 'strict' will prevent people linking to projects
  384. # https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7
  385. sameSiteCookie: 'lax'
  386. # If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc)
  387. # then set this to true to allow it to correctly detect the forwarded IP
  388. # address and http/https protocol information.
  389. behindProxy: false
  390. # Expose the hostname in the `X-Served-By` response header
  391. exposeHostname: process.env['EXPOSE_HOSTNAME'] == 'true'
  392. # Cookie max age (in milliseconds). Set to false for a browser session.
  393. cookieSessionLength: 5 * 24 * 60 * 60 * 1000 # 5 days
  394. # When true, only allow invites to be sent to email addresses that
  395. # already have user accounts
  396. restrictInvitesToExistingAccounts: false
  397. # Should we allow access to any page without logging in? This includes
  398. # public projects, /learn, /templates, about pages, etc.
  399. allowPublicAccess: if process.env["SHARELATEX_ALLOW_PUBLIC_ACCESS"] == 'true' then true else false
  400. enableHomepage: process.env["HOME_PAGE_ENABLED"] == 'true'
  401. # editor should be open by default
  402. editorIsOpen: if process.env["EDITOR_OPEN"] == 'false' then false else true
  403. # site should be open by default
  404. siteIsOpen: if process.env["SITE_OPEN"] == 'false' then false else true
  405. # Use a single compile directory for all users in a project
  406. # (otherwise each user has their own directory)
  407. # disablePerUserCompiles: true
  408. # Domain the client (pdfjs) should download the compiled pdf from
  409. pdfDownloadDomain: process.env["PDF_DOWNLOAD_DOMAIN"] #"http://clsi-lb:3014"
  410. # Maximum size of text documents in the real-time editing system.
  411. max_doc_length: 2 * 1024 * 1024 # 2mb
  412. # Maximum JSON size in HTTP requests
  413. # We should be able to process twice the max doc length, to allow for
  414. # - the doc content
  415. # - text ranges spanning the whole doc
  416. #
  417. # There's also overhead required for the JSON encoding and the UTF-8 encoding,
  418. # theoretically up to 3 times the max doc length. On the other hand, we don't
  419. # want to block the event loop with JSON parsing, so we try to find a
  420. # practical compromise.
  421. max_json_request_size: parseInt(process.env["MAX_JSON_REQUEST_SIZE"]) || 6 * 1024 * 1024 # 6 MB
  422. # Internal configs
  423. # ----------------
  424. path:
  425. # If we ever need to write something to disk (e.g. incoming requests
  426. # that need processing but may be too big for memory, then write
  427. # them to disk here).
  428. dumpFolder: "./data/dumpFolder"
  429. uploadFolder: "./data/uploads"
  430. # Automatic Snapshots
  431. # -------------------
  432. automaticSnapshots:
  433. # How long should we wait after the user last edited to
  434. # take a snapshot?
  435. waitTimeAfterLastEdit: 5 * minutes
  436. # Even if edits are still taking place, this is maximum
  437. # time to wait before taking another snapshot.
  438. maxTimeBetweenSnapshots: 30 * minutes
  439. # Smoke test
  440. # ----------
  441. # Provide log in credentials and a project to be able to run
  442. # some basic smoke tests to check the core functionality.
  443. #
  444. smokeTest:
  445. user: process.env['SMOKE_TEST_USER']
  446. userId: process.env['SMOKE_TEST_USER_ID']
  447. password: process.env['SMOKE_TEST_PASSWORD']
  448. projectId: process.env['SMOKE_TEST_PROJECT_ID']
  449. rateLimitSubject: process.env['SMOKE_TEST_RATE_LIMIT_SUBJECT'] or "127.0.0.1"
  450. stepTimeout: parseInt(process.env['SMOKE_TEST_STEP_TIMEOUT'] or "10000", 10)
  451. appName: process.env['APP_NAME'] or "ShareLaTeX (Community Edition)"
  452. adminEmail: process.env['ADMIN_EMAIL'] or "placeholder@example.com"
  453. adminDomains: JSON.parse(process.env['ADMIN_DOMAINS'] or 'null')
  454. salesEmail: process.env['SALES_EMAIL'] or "placeholder@example.com"
  455. statusPageUrl: process.env['OVERLEAF_STATUS_URL'] or "status.overleaf.com"
  456. nav:
  457. title: "ShareLaTeX Community Edition"
  458. left_footer: [{
  459. text: "Powered by <a href='https://www.sharelatex.com'>ShareLaTeX</a> © 2016"
  460. }]
  461. right_footer: [{
  462. text: "<i class='fa fa-github-square'></i> Fork on Github!"
  463. url: "https://github.com/sharelatex/sharelatex"
  464. }]
  465. showSubscriptionLink: false
  466. header_extras: []
  467. # Example:
  468. # header_extras: [{text: "Some Page", url: "http://example.com/some/page", class: "subdued"}]
  469. recaptcha:
  470. disabled:
  471. invite: true
  472. register: true
  473. customisation: {}
  474. # templates: [{
  475. # name : "cv_or_resume",
  476. # url : "/templates/cv"
  477. # }, {
  478. # name : "cover_letter",
  479. # url : "/templates/cover-letters"
  480. # }, {
  481. # name : "journal_article",
  482. # url : "/templates/journals"
  483. # }, {
  484. # name : "presentation",
  485. # url : "/templates/presentations"
  486. # }, {
  487. # name : "thesis",
  488. # url : "/templates/thesis"
  489. # }, {
  490. # name : "bibliographies",
  491. # url : "/templates/bibliographies"
  492. # }, {
  493. # name : "view_all",
  494. # url : "/templates"
  495. # }]
  496. redirects:
  497. "/templates/index": "/templates/"
  498. reloadModuleViewsOnEachRequest: process.env['NODE_ENV'] == 'development'
  499. disableModule:
  500. 'user-activate': process.env['DISABLE_MODULE_USER_ACTIVATE'] == 'true'
  501. 'launchpad': process.env['DISABLE_MODULE_LAUNCHPAD'] == 'true'
  502. domainLicences: [
  503. ]
  504. sixpack:
  505. domain:""
  506. # ShareLaTeX Server Pro options (https://www.sharelatex.com/university/onsite.html)
  507. # ----------
  508. # LDAP
  509. # ----------
  510. # Settings below use a working LDAP test server kindly provided by forumsys.com
  511. # When testing with forumsys.com use username = einstein and password = password
  512. # ldap :
  513. # host: 'ldap://ldap.forumsys.com'
  514. # dn: 'uid=:userKey,dc=example,dc=com'
  515. # baseSearch: 'dc=example,dc=com'
  516. # filter: "(uid=:userKey)"
  517. # failMessage: 'LDAP User Fail'
  518. # fieldName: 'LDAP User'
  519. # placeholder: 'email@example.com'
  520. # emailAtt: 'mail'
  521. # anonymous: false
  522. # adminDN: 'cn=read-only-admin,dc=example,dc=com'
  523. # adminPW: 'password'
  524. # starttls: true
  525. # tlsOptions:
  526. # rejectUnauthorized: false
  527. # ca: ['/etc/ldap/ca_certs.pem']
  528. #templateLinks: [{
  529. # name : "CV projects",
  530. # url : "/templates/cv"
  531. #},{
  532. # name : "all projects",
  533. # url: "/templates/all"
  534. #}]
  535. rateLimit:
  536. autoCompile:
  537. everyone: process.env['RATE_LIMIT_AUTO_COMPILE_EVERYONE'] or 100
  538. standard: process.env['RATE_LIMIT_AUTO_COMPILE_STANDARD'] or 25
  539. analytics:
  540. enabled: process.env['ANALYTICS_ENABLED'] == 'true'
  541. # currentImage: "texlive-full:2017.1"
  542. # imageRoot: "<DOCKER REPOSITORY ROOT>" # without any trailing slash
  543. compileBodySizeLimitMb: process.env['COMPILE_BODY_SIZE_LIMIT_MB'] or 5
  544. validRootDocExtensions: ['tex', 'Rtex', 'ltx']
  545. emailConfirmationDisabled: (process.env['EMAIL_CONFIRMATION_DISABLED'] == "true") or false
  546. # allowedImageNames: [
  547. # {imageName: 'texlive-full:2017.1', imageDesc: 'TeXLive 2017'}
  548. # {imageName: 'wl_texlive:2018.1', imageDesc: 'Legacy OL TeXLive 2015'}
  549. # {imageName: 'texlive-full:2016.1', imageDesc: 'Legacy SL TeXLive 2016'}
  550. # {imageName: 'texlive-full:2015.1', imageDesc: 'Legacy SL TeXLive 2015'}
  551. # {imageName: 'texlive-full:2014.2', imageDesc: 'Legacy SL TeXLive 2014.2'}
  552. # ]
  553. enabledServices: (process.env['ENABLED_SERVICES'] || 'web,api').split(',').map((s) => s.trim())
  554. # module options
  555. # ----------
  556. modules:
  557. sanitize:
  558. options:
  559. allowedTags: [ 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'blockquote', 'p', 'a', 'ul', 'ol', 'nl', 'li', 'b', 'i', 'strong', 'em', 'strike', 'code', 'hr', 'br', 'div', 'table', 'thead', 'col', 'caption', 'tbody', 'tr', 'th', 'td', 'tfoot', 'pre', 'iframe', 'img', 'figure', 'figcaption', 'span', 'source', 'video', 'del' ]
  560. allowedAttributes:
  561. 'a': [ 'href', 'name', 'target', 'class', 'event-tracking', 'event-tracking-ga', 'event-tracking-label', 'event-tracking-trigger' ]
  562. 'div': [ 'class', 'id', 'style' ]
  563. 'h1': [ 'class', 'id' ]
  564. 'h2': [ 'class', 'id' ]
  565. 'h3': [ 'class', 'id' ]
  566. 'h4': [ 'class', 'id' ]
  567. 'h5': [ 'class', 'id' ]
  568. 'h6': [ 'class', 'id' ]
  569. 'col': [ 'width' ]
  570. 'figure': [ 'class', 'id', 'style']
  571. 'figcaption': [ 'class', 'id', 'style']
  572. 'i': [ 'aria-hidden', 'aria-label', 'class', 'id' ]
  573. 'iframe': [ 'allowfullscreen', 'frameborder', 'height', 'src', 'style', 'width' ]
  574. 'img': [ 'alt', 'class', 'src', 'style' ]
  575. 'source': [ 'src', 'type' ]
  576. 'span': [ 'class', 'id', 'style' ]
  577. 'table': [ 'border', 'class', 'id', 'style' ]
  578. 'td': [ 'colspan', 'rowspan', 'headers', 'style' ]
  579. 'th': [ 'abbr', 'headers', 'colspan', 'rowspan', 'scope', 'sorted', 'style' ]
  580. 'tr': [ 'class' ]
  581. 'video': [ 'alt', 'class', 'controls', 'height', 'width' ]
  582. overleafModuleImports: {
  583. # modules to import (an empty array for each set of modules)
  584. }