General advice

If you are running your local apps using notifications-local, and you run into issues, try the following:

1. Update and restart your Docker daemon
2. If you get errors about log/ folder, use sudo to remove that folder: sudo rm -rf log/
3. If a particular container / app causes issues, try removing that particular container and rebuilding it with no cache, for example:

 docker container rm template-preview-api
 docker compose build template-preview-api

If all the containers are running during these steps, you may need to stop them (ctrl + c) and restart (make up) for the changes to be picked up.

If you encounter issues that were not fixed with the help the above manual, and you manage to troubleshoot them, please add new troubleshooting instructions to this manual, thanks!

Missing environment variables

Environment variables for the apps are set in ./private/[name of app].env files, created by the ./generate-env-files.sh script you run in step 3 of the set up process. Some of them come from local checkouts of repositories for each app's code.

Apps will change their code sometimes, in which case you might see errors from missing or incorrect environment variables. To fix this, make sure you have the latest app code checked out and re-run ./generate-env-files.sh.

Missing ./docker/Arial.ttf file

This file is now stored in the notifications-private-assets repository. You need to check that repository out locally and copy the file across manually. See the pull request that removed ./docker/Arial.ttf for details.