settings.defaults.coffee 22 KB

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