a648015db8
* Merge all .prettierignore files into top-level config * Merge all .prettierrc files into top-level config * Replace service-specific glob patterns in package.json format scripts with `prettier .` * Add template files with Jinja2, Go template, envsubst, and Handlebars syntax to .prettierignore * Ignore GitHub templates * Ignore PUG templates to format them separately with `format:pug` * Encourage double quotes for YAML, YML files * Move prettier for PUG source format script to the root * Move prettier for styles source format script to the root * Remove prettier for jenkins files from web * Remove prettier source format script from all services * Make .prettierrc more readable * Update format scripts by file type * Organise `.prettierignore` * Add `--cache` flag to prettier scripts for faster runs * Format all files with prettier * Format all or format services * Remove `format`/`format:fix` scripts from services since now it runs from root `package.json` * Avoid conlficts with yamllint configuration * Remove `--cache` flag from prettier scripts * Update all service Makefiles to use root-level prettier configuration * Update all Jenkinsfile to use root-level prettier configuration * Ignore auto-generated files by build_scripts * Update package-lock.json * Update root Makefile format targets * Update SP Jenkinsfile format target * Update E2E Makefile format script * Udpate `format_js` to work in both local and CI env * Add docker-mailtrap to .prettierignore docker-mailtrap is a third-party git-ignored directory used for testing * Added Docker env detection to prevent nested Docker spawning * Ignore handlebars templates * Add cryptographic files and test output to `.prettierignore` * Add terraform modules to `.gitignore` * Remove prettier-plugin-groovy * Use npx directly instead of Docker for local formatting for faster formatting * Auto-generate Makefiles * Revert "Remove prettier-plugin-groovy" This reverts commit 194a33589a2e1e4d2225d10c67e9f025e4222025. * Mount monorepo root in RUN_LINT_FORMAT for prettier config access * Prettier ignores all `node_modules` by default regardless of location * Show only changed files in format output * Ignore LICENSE files * Enable prettier on rendered build_scripts outputs * Ignoring all the template folders by prettier * Remove the public/minjs entry since it does not exist * Remove all non-existent paths * Sync `.prettierignore` with ignored files by `.gitignore` and `.dockerignore` files * Revert "Auto-generate Makefiles" This reverts commit c0233e490de1bc95fe437219d65e0b66e0331ec9. * Revert "Use npx directly instead of Docker for local formatting for faster formatting" This reverts commit 1d2b2cf1a6c6974c76885852a90dd55e84167e41. * Ignore dashboard JSON files * Ignore files generated by bin/update_build_scripts * Remove unsupported file types from `.prettierignore` * Ignore test fixture generated files * Ignore README file types by prettier * Ignore generate snapshots by prettier * Allow to format generated bin/update_build_scripts by prettier * Ensure build script outputs prettier-compatible tsconfig.json * Fix build script output to match prettier formatting - Fix Jinja2 whitespace in docker-compose templates - Change YAML quotes from single to double * Don't read cryptographic files by prettier * Ignore google verification files by prettier * Revert npx prettier formatting * Ignore domain verification files * Show only changed files in format output * Make `.github` prettier * Allow all files to be formatted in jobs by prettier * Allow server-ce/server-pro files to be formatted by prettier * Ignore more folders in clsi, filestory, git-bridge by prettier * Update build script with `RUN_LINTING_CI_MONOREPO` * Ignore docker-mailtrap and downloads in server-ce by prettier * Restore prettier configs and prettierignore for V1 since it has its own prettier (an older version) * Source format GitOrigin-RevId: 637adc3cc422d1f20c86d6ebc8ec514d60758287
Overleaf Community Edition, development environment
Building and running
In this develop directory, build the services:
bin/build
Note
If Docker is running out of RAM while building the services in parallel, create a
.envfile in this directory containingCOMPOSE_PARALLEL_LIMIT=1.
Then start the services:
bin/up
Once the services are running, open http://localhost/launchpad to create the first admin account.
TeX Live
Compiling a PDF requires building a TeX Live image to handle the compilation inside Docker:
docker build texlive -t texlive-full
Note
To compile on a macOS host, you may need to override the path to the Docker socket by creating a
.envfile in this directory, containingDOCKER_SOCKET_PATH=/var/run/docker.sock.raw
Development
To avoid running bin/build && bin/up after every code change, you can run Overleaf
Community Edition in development mode, where services will automatically update on code changes.
To do this, use the included bin/dev script:
bin/dev
This will start all services using node --watch, which will automatically monitor the code and restart the services as necessary.
To improve performance, you can start only a subset of the services in development mode by providing a space-separated list to the bin/dev script:
bin/dev [service1] [service2] ... [serviceN]
Note
Starting the
webservice in development mode will only update thewebservice when backend code changes. In order to automatically update frontend code as well, make sure to start thewebpackservice in development mode as well.
If no services are named, all services will start in development mode.
Debugging
When run in development mode most services expose a debugging port to which you can attach a debugger such as the inspector in Chrome's Dev Tools or one integrated into an IDE. The following table shows the port exposed on the host machine for each service:
| Service | Port |
|---|---|
web |
9229 |
clsi |
9230 |
chat |
9231 |
contacts |
9232 |
docstore |
9233 |
document-updater |
9234 |
filestore |
9235 |
notifications |
9236 |
real-time |
9237 |
history-v1 |
9239 |
project-history |
9240 |
To attach to a service using Chrome's remote debugging, go to
chrome://inspect/ and make sure Discover network targets is checked. Next
click Configure... and add an entry localhost:[service port] for each of the
services you want to attach a debugger to.
After adding an entry, the service will show up as a Remote Target that you can inspect and debug.