chk
/
AppFlowy-Cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update deployment doc (#171)

This commit is contained in:
Jiraffe7 2023-11-20 12:08:54 +08:00 committed by GitHub
parent 3fe8e6d88a
commit 76bdeabd85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/deployment.md
View File

@ -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