feat: add README

src/mongodb-replicaset/README.md

@@ -0,0 +1,62 @@
+# MongoDB Replica Set
+
+[English](./README.md) | [中文](./README.zh.md)
+
+This service sets up a MongoDB replica set with three members.
+
+## Prerequisites
+
+1. Generate a key file for the replica set:
+
+   ```bash
+   openssl rand -base64 756 > ./secrets/rs0.key
+   ```
+
+## Initialization
+
+1. Start the services:
+
+   ```bash
+   docker compose up -d
+   ```
+
+2. Connect to the primary node:
+
+   ```bash
+   docker exec -it mongodb-replicaset-mongo1-1 mongosh
+   ```
+
+3. Initialize the replica set. **Remember to replace the host IP with your actual host IP.**
+
+   ```js
+   config = {
+     _id: "rs0",
+     members: [
+       {_id: 0, host: "192.168.31.38:27017"},
+       {_id: 1, host: "192.168.31.38:27018"},
+       {_id: 2, host: "192.168.31.38:27019"},
+     ]
+   }
+   rs.initiate(config)
+   ```
+
+## Services
+
+- `mongo1`: The first member of the replica set.
+- `mongo2`: The second member of the replica set.
+- `mongo3`: The third member of the replica set.
+
+## Configuration
+
+- `MONGO_VERSION`: The version of the MongoDB image, default is `8.0.13`.
+- `MONGO_INITDB_ROOT_USERNAME`: The root username for the database, default is `root`.
+- `MONGO_INITDB_ROOT_PASSWORD`: The root password for the database, default is `password`.
+- `MONGO_INITDB_DATABASE`: The initial database to create, default is `admin`.
+- `MONGO_REPLICA_SET_NAME`: The name of the replica set, default is `rs0`.
+- `MONGO_PORT_OVERRIDE_1`: The host port for the first member, default is `27017`.
+- `MONGO_PORT_OVERRIDE_2`: The host port for the second member, default is `27018`.
+- `MONGO_PORT_OVERRIDE_3`: The host port for the third member, default is `27019`.
+
+## Volumes
+
+- `secrets/rs0.key`: The key file for authenticating members of the replica set.

src/mongodb-replicaset/README.zh.md

@@ -1,22 +1,62 @@
-# MongoDB
+# MongoDB 副本集
 
-```bash
-docker exec -it mongodb-mongo1-1 mongosh
-```
+[English](./README.md) | [中文](./README.zh.md)
 
-初始化副本集：
+此服务用于搭建一个包含三个成员的 MongoDB 副本集。
 
-```js
-use admin
-db.auth('root', '$MONGO_ROOT_PASSWORD')
-config = {
-  _id: "rs0",
-  members: [
-    {_id: 0, host: "192.168.31.38:27017"},
-    {_id: 1, host: "192.168.31.38:27018"},
-    {_id: 2, host: "192.168.31.38:27019"},
-  ]
-}
-rs.initiate(config)
-exit
-```
+## 前提条件
+
+1. 为副本集生成一个密钥文件：
+
+   ```bash
+   openssl rand -base64 756 > ./secrets/rs0.key
+   ```
+
+## 初始化
+
+1. 启动服务：
+
+   ```bash
+   docker compose up -d
+   ```
+
+2. 连接到主节点：
+
+   ```bash
+   docker exec -it mongodb-replicaset-mongo1-1 mongosh
+   ```
+
+3. 初始化副本集。**请记得将 host IP 替换为你的实际主机 IP。**
+
+   ```js
+   config = {
+     _id: "rs0",
+     members: [
+       {_id: 0, host: "192.168.31.38:27017"},
+       {_id: 1, host: "192.168.31.38:27018"},
+       {_id: 2, host: "192.168.31.38:27019"},
+     ]
+   }
+   rs.initiate(config)
+   ```
+
+## 服务
+
+- `mongo1`: 副本集的第一个成员。
+- `mongo2`: 副本集的第二个成员。
+- `mongo3`: 副本集的第三个成员。
+
+## 配置
+
+- `MONGO_VERSION`: MongoDB 镜像的版本，默认为 `8.0.13`。
+- `MONGO_INITDB_ROOT_USERNAME`: 数据库的 root 用户名，默认为 `root`。
+- `MONGO_INITDB_ROOT_PASSWORD`: 数据库的 root 密码，默认为 `password`。
+- `MONGO_INITDB_DATABASE`: 要创建的初始数据库，默认为 `admin`。
+- `MONGO_REPLICA_SET_NAME`: 副本集的名称，默认为 `rs0`。
+- `MONGO_PORT_OVERRIDE_1`: 第一个成员的主机端口，默认为 `27017`。
+- `MONGO_PORT_OVERRIDE_2`: 第二个成员的主机端口，默认为 `27018`。
+- `MONGO_PORT_OVERRIDE_3`: 第三个成员的主机端口，默认为 `27019`。
+
+## 卷
+
+- `secrets/rs0.key`: 用于副本集成员之间认证的密钥文件。