DEPLOYMENT.md•2.79 kB
# Deployment Guide for Zillow MCP Server
This document provides instructions for deploying the Zillow MCP server to various cloud environments.
## Prerequisites
Before deploying, ensure you have:
1. A Zillow API key (request access at api@bridgeinteractive.com)
2. Docker installed (for containerized deployment)
3. Access to your chosen cloud platform
## Environment Variables
The server requires the following environment variables:
- `ZILLOW_API_KEY`: Your Zillow API key
## Deployment Options
### Docker Deployment
The simplest way to deploy is using Docker:
```bash
# Build the Docker image
docker build -t zillow-mcp-server .
# Run with environment variables
docker run -p 8000:8000 -e ZILLOW_API_KEY=your_key_here zillow-mcp-server
```
### AWS Elastic Beanstalk
1. Create a new Elastic Beanstalk application
2. Choose Docker as the platform
3. Upload the project as a ZIP file
4. Configure environment variables in the Elastic Beanstalk console
5. Deploy the application
### Google Cloud Run
1. Build and push the Docker image to Google Container Registry:
```bash
gcloud builds submit --tag gcr.io/your-project-id/zillow-mcp-server
```
2. Deploy to Cloud Run:
```bash
gcloud run deploy zillow-mcp-server \
--image gcr.io/your-project-id/zillow-mcp-server \
--platform managed \
--set-env-vars ZILLOW_API_KEY=your_key_here
```
### Microsoft Azure Container Instances
1. Build and push the Docker image to Azure Container Registry
2. Deploy to Azure Container Instances with environment variables
### Heroku
1. Create a new Heroku app
2. Set up the Heroku container registry
3. Build and push the Docker image
4. Set environment variables in the Heroku dashboard
## Scaling Considerations
- The server is stateless and can be horizontally scaled
- Consider rate limits of the Zillow API when scaling
- For high-traffic deployments, implement a caching layer
## Security Recommendations
1. Never commit your `.env` file to version control
2. Use secrets management services provided by your cloud platform
3. Set up HTTPS for all production deployments
4. Implement API key rotation policies
5. Consider adding authentication to the HTTP server mode
## Monitoring
1. Set up health checks using the `/health` endpoint
2. Configure logging to capture API errors and rate limit issues
3. Set up alerts for service disruptions
## Troubleshooting
If you encounter issues:
1. Check the server logs for error messages
2. Verify your API key is valid and has the necessary permissions
3. Ensure your cloud environment has outbound internet access
4. Check for rate limiting issues with the Zillow API
## Support
For issues with the server code, please open an issue on the GitHub repository.
For issues with the Zillow API, contact Zillow Bridge API support.