Mcpo Docker Use

🚀 Docker Build and Deployment Guide (mcpo Project)

Thanks to @BigUncle for the pull request.

This guide comprehensively introduces how to use Docker to build and deploy the mcpo project, and provides detailed configuration information and best practices.

🚀 Quick Start

This guide will walk you through the process of building and deploying the mcpo project using Docker, offering detailed configuration information and best practices.

✨ Features

1. Functional Features

• Dynamic Dependency Installation: Automatically download and install required dependency packages according to config.json when the container starts.
• Non-root User Operation: By default, it runs as the appuser user to enhance security.
• Persistent Storage: Automatically mount configuration files and data directories to the host machine to prevent data loss upon restart.

2. Core Components

• Configuration Management: Define service parameters through config.json and support dynamic updates.
• Logging System: Integrate an efficient log output module for easy monitoring and troubleshooting.
• Dependency Isolation: Use an independent dependency storage directory to avoid conflicts between different projects.

📦 Installation

1. Environment Preparation

• Install Docker and ensure it is running properly.
• Install docker-compose for container orchestration management.

2. Download the Code Repository

git clone https://github.com/yourusername/mcpo.git
cd mcpo

3. Configure Environment Variables

Create a .env file and fill in the necessary configurations:

PIP_SOURCE=https:// mirrors.aliyun.com/pypi/simple/
# Other custom environment variables...

4. Build the Image

Run the following command to build the Docker image:

docker-compose build [--no-cache]

5. Start the Service

Start the container and run it in the background:

docker-compose up -d

📚 Documentation

1. Common Issues and Solutions

Permission Issues: User has no access to certain directories

Symptom: Permission denied error during runtime. Solution:

• Ensure that all directories requiring write access have the correct permissions set.
• Add volumes in docker-compose.yml to specify the mapping between the host directory and the container.

Network Connection Issues: Dependency download fails

Symptom: Unable to download packages due to network issues during the build process. Solution:

• Use domestic mirror sources, such as Alibaba Cloud or Douban's PyPI mirror.
• Check the network settings of the Docker daemon to ensure it can access the external network.

Abnormal Log Output

Symptom: Log files are empty or the content is chaotic. Solution:

• Confirm that the logging configuration is correct and the log directory is writable.
• Check the runtime log stream to identify any error messages.

2. Notes and Best Practices

Security Recommendations

• Run containers as non-root users.
• Avoid hardcoding sensitive information in the Dockerfile.
• Regularly update dependencies to the latest stable versions.

Performance Optimization

• Set reasonable resource limits based on actual resource availability.
• Enable Docker's memory management and cgroup control.
• Use multi-stage builds to reduce the image size.

Maintenance Recommendations

• Regularly back up persistent directories.
• Monitor container runtime status and handle exceptions promptly.
• Update documentation and the README to reflect the latest configuration requirements.

3. Quick Reference Commands

4. Appendix

Example Configuration File

{
    "version": "1",
    "services": {
        "amap_mcp_server": {
            "image": "your-docker-image",
            "command": "start-server --config /app/config.json"
        }
    }
}

Log Directory Structure

mcpo/
├── logs/
│   ├── amap_mcp_server.log
│   └── other_service.log
└── data/
    └── important_data.db

By following this guide, you can successfully set up the Docker environment for the mcpo project and perform daily maintenance tasks. If you encounter any other issues, please refer to the project documentation or contact the development team for assistance.