Add troubleshooting section

Signed-off-by: Artem Savchenko <armisav@gmail.com>
This commit is contained in:
Artem Savchenko
2026-02-24 20:32:57 +07:00
parent a5fa04cda8
commit 32e37f508d
+21 -1
View File
@@ -2,7 +2,7 @@
Please use this README if you want to deploy Huly on your server with `docker compose`. I'm using a Basic Droplet on Digital Ocean with Ubuntu 24.04, but these instructions can be easily adapted for any Linux distribution.
If you prefer Kubernetes deployment, there is a sample Kubernetes configuration under [kube](kube) directory.
If you prefer Kubernetes deployment, there is a sample Kubernetes configuration under [kube](kube) directory. To deploy with [Coolify](https://coolify.io) using a PostgreSQL-based stack and Coolify's built-in proxy, use the [Coolify deployment guide](guides/coolify-deployment.md) and set the compose path to `coolify/docker-compose.yaml` in Coolify's Docker Compose build pack.
## System Requirements
@@ -104,6 +104,26 @@ Now, launch your web browser and enjoy Huly! To stop all services, run `docker c
> [!IMPORTANT]
> Provided configrations include deployments of CockroachDB and Redpanda which might not be production-ready. Please inspect them carefully before using in production. For more information on the recommended deployment configurations, please refer to the [CockroachDB](https://www.cockroachlabs.com/docs/stable/recommended-production-settings) and [Redpanda](https://docs.redpanda.com/24.3/deploy/) documentation.
## Troubleshooting
### Huly opens, but user sign-up fails
If the UI loads but sign-up fails, check logs for the `account` service first:
```bash
docker compose logs -f account
```
This usually reveals issues with account callbacks, URL configuration, or connectivity to dependent services.
### SSL errors (for example: `SSL wrong version number`)
This usually means HTTPS/WSS is enabled in configuration, but the endpoint is serving plain HTTP/WS or has invalid TLS setup.
- Verify your Nginx TLS configuration and certificates (`ssl_certificate`, `ssl_certificate_key`).
- Confirm your domain points to the correct host and that port `443` is reachable.
- For local/testing deployments, disable secure mode by setting `SECURE=` in `huly_v7.conf`, then regenerate/reload config and restart containers.
## Volume Configuration
By default, Huly uses Docker named volumes to store persistent data (database, Elasticsearch indices, and uploaded files). You can optionally configure custom host paths for these volumes during the setup process.