From 76bdeabd8544fc6b76bcc782ab0c15f63d99b013 Mon Sep 17 00:00:00 2001 From: Jiraffe7 Date: Mon, 20 Nov 2023 12:08:54 +0800 Subject: [PATCH] docs: update deployment doc (#171) --- doc/deployment.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/deployment.md b/doc/deployment.md index f9e35dd5..67d42c3b 100644 --- a/doc/deployment.md +++ b/doc/deployment.md @@ -15,10 +15,12 @@ we recommend using cloud compute services (as your host server) such as Ensure you have Docker Compose installed on your host server. Follow the official guidelines for a reliable setup: -- **Docker Compose:** Install it as per the [official documentation](https://docs.docker.com/compose/install/). - +Docker Compose is included with Docker Engine: - **Docker Engine:** We suggest adhering to the instructions provided by Docker for [installing Docker Engine](https://docs.docker.com/engine/install/). +For older versions of Docker Engine that do not include Docker Compose: +- **Docker Compose:** Install it as per the [official documentation](https://docs.docker.com/compose/install/). + ## Steps @@ -129,6 +131,11 @@ tag for the `appflowy_cloud` and `admin_frontend` images from Docker Hub by defa environment variable, it will pull the specified version instead. If `BACKEND_VERSION` is not set, Docker Compose defaults to using the `latest` tag. +- The metrics endpoint can also be used to verify that the AppFlowy-Cloud server is running. It should return a status of 200 OK. +```bash +curl -v localhost:8000/metrics +``` + ### 4. Reconfiguring and redeployment - It is very common to reconfigure and restart. To do so, simply edit the `.env` and do `docker compose up -d` again