docs: add docs for docker deployment

hehao98 · Apr 19, 2024 · fdc7d2a · fdc7d2a
1 parent b71db7f
commit fdc7d2a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 49 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,5 +1,30 @@
 # Development
 
+## Deploy
+
+We strongly recommend deploying this tool on Docker. To begin, you need to have the following:
+
+1. A x86-64 Linux machine with at least 4 GB of memory and 8 GB of disk space.
+2. Docker installed on the machine. Refer to the [official documentation](https://docs.docker.com/get-docker/) for installation instructions.
+
+To deploy this tool, first clone this repository and navigate to the `docker` directory of this repository. Then, run the following command:
+
+```shell
+docker-compose up -d
+```
+
+You may check the logs using the following command:
+
+```shell
+docker-compose logs -f --tail 100
+```
+
+To stop:
+
+```shell
+docker-compose down
+```
+
 ## Compile
 
 ### Local

diff --git a/Dockerfile b/Dockerfile