Add deploy.sh script for Docker build and deployment
- Add comprehensive deploy.sh script with build, run, push, deploy, and clean commands - Support configurable image tags, registries, and image names - Add Docker deployment documentation to README.md - Update project structure to include deploy.sh
This commit is contained in:
36
README.md
36
README.md
@@ -62,6 +62,41 @@ Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
||||
}
|
||||
```
|
||||
|
||||
## Docker Deployment
|
||||
|
||||
A [`deploy.sh`](deploy.sh:1) script is provided for easy Docker build and deployment.
|
||||
|
||||
### Quick Start
|
||||
|
||||
```bash
|
||||
./deploy.sh build # Build the Docker image
|
||||
./deploy.sh run # Run the container locally
|
||||
```
|
||||
|
||||
### Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `build` | Build the Docker image |
|
||||
| `run` | Run the container locally with cache volume |
|
||||
| `push` | Push the image to a registry |
|
||||
| `deploy` | Build and push in one step |
|
||||
| `clean` | Remove local images and containers |
|
||||
|
||||
### Options
|
||||
|
||||
```bash
|
||||
./deploy.sh build -t v1.0.0 # Build with specific tag
|
||||
./deploy.sh push -r docker.io/myuser/ # Push to Docker Hub
|
||||
./deploy.sh deploy -t v1.0.0 -r ghcr.io/myuser/ # Build and push to GitHub Container Registry
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `IMAGE_TAG` - Image tag (default: latest)
|
||||
- `REGISTRY` - Registry prefix (e.g., "docker.io/username/")
|
||||
- `IMAGE_NAME` - Image name (default: character-details)
|
||||
|
||||
## Cache
|
||||
|
||||
Character data is cached at `~/.local/share/character_details/cache/` as JSON files.
|
||||
@@ -79,6 +114,7 @@ character_details/
|
||||
server.py # FastMCP server and tool definitions
|
||||
pyproject.toml
|
||||
README.md
|
||||
deploy.sh # Docker build and deployment script
|
||||
```
|
||||
|
||||
## Test Characters
|
||||
|
||||
Reference in New Issue
Block a user