Instance Upgrade
1. Upgrade Overview
Due to its simple architecture and streamlined deployment, upgrading a Docker Compose installation is significantly easier compared to other methods. Upgrades typically involve updating the container images and making minor configuration adjustments.
2. Upgrade Procedure
Pull Images and Recreate Containers
Execute the following command in your project directory to fetch the latest images and restart the services:
docker compose pull && docker compose up -d
Verify Service Status
After the containers have restarted, confirm that all internal services are healthy:
docker exec -it csghub-omnibus csghub-ctl status
3. Post-Upgrade Troubleshooting
If the services are abnormal after an upgrade, follow these steps to diagnose the issue:
Check Docker Compose Logs
View the container's standard output to identify initialization or environment errors:
docker compose logs -f
- Initialization Errors: Usually indicate a syntax error or a breaking change in the
docker-compose.yamlconfiguration format. - Runtime Errors: May indicate issues with internal service dependencies.
Check Specific Service Logs
If the main Docker logs show no obvious errors, enter the container to inspect logs for the specific failing component:
# View logs for all or a specific service (e.g., csghub-ctl tail server)
docker exec -it csghub-omnibus csghub-ctl tail <service_name>
4. Support
If you are unable to determine the cause of the failure, please collect the relevant logs and submit a support request via the official issue tracker.