diff --git a/docker/README.md b/docker/README.md index 77286dae1b..d9a313cbfd 100644 --- a/docker/README.md +++ b/docker/README.md @@ -51,7 +51,7 @@ For local image builds, use the [Go image build guide](../docs/develop/build_doc Verify the deployment with: ```bash -docker compose -f docker-compose.yml ps +docker ps docker logs --tail 100 ragflow-cpu curl -f http://localhost/api/v1/system/healthz ``` diff --git a/docs/administrator/migration/backup_and_migration.md b/docs/administrator/migration/backup_and_migration.md index f5cf5f5f86..fffb4ea9fb 100644 --- a/docs/administrator/migration/backup_and_migration.md +++ b/docs/administrator/migration/backup_and_migration.md @@ -21,7 +21,7 @@ The bundled `docker/migration.sh` covers only the MySQL, MinIO, Redis, and Elast From the repository root, inspect the running deployment and its Docker volumes: ```bash -docker compose --env-file docker/.env -f docker/docker-compose.yml ps +docker ps docker volume ls ``` @@ -97,7 +97,7 @@ Start the Go stack with the target configuration and the same Compose project na ```bash docker compose --env-file docker/.env -f docker/docker-compose.yml up -d -docker compose --env-file docker/.env -f docker/docker-compose.yml ps +docker ps ``` The Go image's entrypoint runs the standalone database migration before starting its enabled server modes. Check the container logs for migration errors before using the service. Confirm that an existing dataset can list and open files and that search still returns its documents. diff --git a/docs/develop/build_docker_image.mdx b/docs/develop/build_docker_image.mdx index 58718ca0e0..dc656945d0 100644 --- a/docs/develop/build_docker_image.mdx +++ b/docs/develop/build_docker_image.mdx @@ -61,7 +61,7 @@ The Compose deployment starts the `ragflow-cpu` service. The open-source 1.0 Go ## Verify the service ```bash -docker compose -f docker-compose.yml ps +docker ps docker logs --tail 50 ragflow-cpu curl -f http://localhost/api/v1/system/healthz ``` diff --git a/docs/develop/launch_ragflow_from_source.md b/docs/develop/launch_ragflow_from_source.md index e5d8423b00..8555aa2cd4 100644 --- a/docs/develop/launch_ragflow_from_source.md +++ b/docs/develop/launch_ragflow_from_source.md @@ -115,7 +115,7 @@ The change made with `sysctl -w` is temporary. To preserve it after a reboot, ad ```bash docker compose --env-file docker/.env -f docker/docker-compose-base.yml up -d --wait es01 mysql minio nats kvrocks clickhouse -docker compose --env-file docker/.env -f docker/docker-compose-base.yml ps +docker ps ``` The base Compose file also defines an unprofiled Redis service. Starting every service with `up -d` can make Redis and Kvrocks compete for host port 6379; the explicit service list above starts Kvrocks for the Go backend. Compose may print a warning that `REDIS_PORT` is unset because the unused Redis service is still parsed. diff --git a/docs/faq.mdx b/docs/faq.mdx index 41fa377ca4..2f87e52762 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -144,7 +144,7 @@ Check that the Go API and Admin services started, then review the RAGFlow contai ![anomaly](https://github.com/infiniflow/ragflow/assets/93570324/beb7ad10-92e4-4a58-8886-bfb7cbd09e5d) -You cannot log in until the services are initialized. Review the RAGFlow container logs (`docker compose --env-file docker/.env -f docker/docker-compose.yml logs -f ragflow-cpu` from the repository root). The Go services log these startup messages: +You cannot log in until the services are initialized. Review the RAGFlow container logs (`docker logs -f ragflow-cpu` from the repository root). The Go services log these startup messages: ```text Starting api server: ... @@ -181,7 +181,7 @@ Click the red cross beside the 'parsing status' bar, then restart the parsing pr 1. Check the RAGFlow container logs for API, admin, and ingestor startup errors: ```bash - docker compose --env-file docker/.env -f docker/docker-compose.yml logs -f ragflow-cpu + docker logs -f ragflow-cpu ``` @@ -220,7 +220,7 @@ From the repository root, follow the Go service logs written to the mounted log tail -f docker/ragflow-logs/*.log ``` -To view the container's combined output, use `docker compose --env-file docker/.env -f docker/docker-compose.yml logs -f ragflow-cpu`. +To view the container's combined output, use `docker logs -f ragflow-cpu`. --- @@ -229,13 +229,13 @@ To view the container's combined output, use `docker compose --env-file docker/. 1. From the repository root, check the Go deployment's containers: ```bash - docker compose --env-file docker/.env -f docker/docker-compose.yml ps + docker ps ``` Review the RAGFlow service logs: ```bash - docker compose --env-file docker/.env -f docker/docker-compose.yml logs -f ragflow-cpu + docker logs -f ragflow-cpu ``` Check the `nats` and selected document engine services in the same Compose project when diagnosing ingestion or indexing. @@ -251,7 +251,7 @@ A running container does not necessarily mean that the service inside it is heal 1. Check the status of the Elasticsearch Docker container: ```bash - docker compose --env-file docker/.env -f docker/docker-compose.yml ps es01 + docker ps |grep es01 ``` A healthy Elasticsearch container should report `healthy`. The default Go Compose deployment exposes Elasticsearch on host port `1200`, while the container listens on port `9200`. @@ -388,7 +388,7 @@ Existing document indexes are not transferred to Infinity automatically. Back up ```bash docker compose --env-file docker/.env -f docker/docker-compose.yml up -d - docker compose --env-file docker/.env -f docker/docker-compose.yml ps + docker ps ``` 4. Reprocess or reindex the documents so their searchable content is written to Infinity. Verify retrieval before retiring the old Elasticsearch data. diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 9c54b93db0..d010dbc6d2 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -64,7 +64,7 @@ If Docker is not installed, see [Install Docker Engine](https://docs.docker.com/ 4. Check that the service is running: ```bash - docker compose -f docker-compose.yml ps + docker ps docker logs -f ragflow-cpu ```