https-portal icon indicating copy to clipboard operation
https-portal copied to clipboard

Readme contains some questionable troubleshooting advice

Open brianmullinorum opened this issue 11 months ago • 0 comments

Hi!

My company uses Retool which, in its default, self-hosted configuration, is able to rely on the https-portal docker image to manage its SSL certs.

I was having some trouble with the https-portal container, leading me to run the following commands from Retool's docs in order to debug the issue:

docker-compose exec https-portal bash
cd /var/log/nginx
cat error.log

For some reason, cat error.log was not returning, blocking my ability to debug further. An internet search lead me to your repo's Readme and the Troubleshooting section. Long story short, I ran docker-compose down -v as instructed under "Reset the data volume," which promptly deleted all of my company's Retool application code.

Though Retool recommends that you do not rely on Docker volumes to persist application data, this is how it behaves by default, and we never changed the default. This has been a painful experience.

Considering that https-portal is rather likely to be used in a compose configuration with other docker containers, perhaps the suggested commands should read something like

docker-compose down
docker volume rm $(docker volume ls -q | grep https-portal-data)
docker-compose up

or at least have the Readme include additional disclaimers about the consequences of deleting Docker volumes.

brianmullinorum avatar Feb 05 '25 22:02 brianmullinorum