Skip to content

feat: Documentation Improvement: Add Detailed Setup Steps for Docker Compose #1

@tavigaussboy9

Description

@tavigaussboy9

Description

The current README provides instructions for launching individual middleware services like Redis and Nacos using Docker commands. However, it does not include a docker-compose.yml example or detailed guidance on using Docker Compose to simplify the setup of the entire application stack.

Suggested Improvement

Please consider adding a section that outlines how to deploy all services using Docker Compose. This can improve usability for users who want to set up the environment quickly without managing each container manually.

Example Section to Include:

🐳 使用 Docker Compose 启动整个应用

version: '3.8'
services:
  redis:
    image: redis:latest
    ports:
      - "6379:6379"
    volumes:
      - /root/redis/conf/redis.conf:/usr/local/etc/redis/redis.conf
    command: --appendonly yes
  nacos:
    image: nacos/nacos-server:latest
    ports:
      - "8848:8848"
      - "9848:9848"
    environment:
      - PREFER_HOST_MODE=hostname
      - MODE=standalone
      - NACOS_AUTH_IDENTITY_KEY=serverIdentity
      - NACOS_AUTH_IDENTITY_VALUE=security
      - NACOS_AUTH_TOKEN=SecretKey012345678901234567890123456789012345678901234567890123456789
  # Add other services like im-gateway, im-auth, im-connect, and im-server here

启动命令

在应用根目录中运行以下命令:

docker-compose up -d

This addition will help users get started quickly and efficiently.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions