Troubleshooting
This section lists common issues you might encounter during development and how to resolve them.
Services are not starting
If the services are not starting correctly, here are a few things to check:
.envfile: Ensure that your.envfile is correctly configured and that all necessary environment variables are set.- Docker is running: Make sure that the Docker daemon is running.
- Ports are available: Check if the ports used by the services are not already in use by other applications. You can see the ports in the
docker-compose.dev.yamlfile. - Docker Compose logs: Check the logs for any error messages:
db-prestart service fails
If the db-prestart service fails, it is likely due to an issue with the database migrations.
- Check the logs: Look at the logs of the
db-prestartservice for any error messages from Alembic. - Migration conflicts: If you have been working on a feature branch and have a conflict with migrations from the
mainbranch, you may need to resolve the conflict manually. You can do this by editing the migration files indb/alembic/versions.
Permission errors with backup directory
You might need to give write-access to the backup-location folder to all user groups.
If you are getting permission errors when running the backup scripts, you can try changing the permissions of the backup directory:
build.sh script fails
If the build.sh script fails, here are a few things to check:
DOCKER_REGISTRYenvironment variable: Make sure that theDOCKER_REGISTRYenvironment variable is set in your.envfile.- Lock files: The
build.shscript checks foruv.lockandpackage-lock.jsonfiles. If these files are missing, you will need to generate them by runninguv lockornpm installin the respective service directories. - Docker Hub login: If you are pushing to a private Docker Hub repository, you will need to be logged in to Docker Hub. You can log in with the
docker logincommand.