From 5498a7a7fe69d204c02fb598af2cca2ae22d2c8a Mon Sep 17 00:00:00 2001
From: AnduinXue <anduin@aiursoft.com>
Date: Thu, 11 Jan 2024 14:16:23 +0000
Subject: [PATCH] New compliant.

---
 README.md | 37 +++++++++++++++++++++++++++++++------
 1 file changed, 31 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f93737e..76d6796 100644
--- a/README.md
+++ b/README.md
@@ -29,19 +29,44 @@ curl -sL https://gitlab.aiursoft.cn/aiursoft/chessserver/-/raw/master/install.sh
 
 It will install the app as a systemd service, and start it automatically. Binary files will be located at `/opt/apps`. Service files will be located at `/etc/systemd/system`.
 
-## Run locally
+## Run manually
 
 Requirements about how to run
 
-1. [.NET 7 SDK](http://dot.net/)
-2. Run `npm i` at directory `/src/Aiursoft.ChessServer/wwwroot/`
-3. Execute `dotnet run` to run the app
-4. Use your browser to view [http://localhost:5000](http://localhost:5000)
+1. Install [.NET 7 SDK](http://dot.net/) and [Node.js](https://nodejs.org/).
+2. Execute `npm install` at `wwwroot` folder to install the dependencies.
+3. Execute `dotnet run` to run the app.
+4. Use your browser to view [http://localhost:5000](http://localhost:5000).
 
 ## Run in Microsoft Visual Studio
 
 1. Open the `.sln` file in the project path.
-2. Press `F5`.
+2. Press `F5` to run the app.
+
+## Run in Docker
+
+First, install Docker [here](https://docs.docker.com/get-docker/).
+
+Then run the following commands in a Linux shell:
+
+```bash
+image=hub.aiursoft.cn/aiursoft/chessserver
+appName=chessserver
+docker pull $image
+docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image
+```
+
+That will start a web server at `http://localhost:5000` and you can test the app.
+
+The docker image has the following context:
+
+| Properties  | Value                               |
+|-------------|-------------------------------------|
+| Image       | hub.aiursoft.cn/aiursoft/chessserver|
+| Ports       | 5000                                |
+| Binary path | /app                                |
+| Data path   | /data                               |
+| Config path | /data/appsettings.json              |
 
 ## How to contribute