@@ -29,17 +29,29 @@ To add this token to GitHub:
29295 . Value: Paste your npm token
30306 . Click "Add secret"
3131
32- ### 2. ` GITHUB_TOKEN `
32+ ### 2. ` DOCKER_USERNAME ` and ` DOCKER_PASSWORD `
33+
34+ These secrets are used to publish Docker images to Docker Hub.
35+
36+ To set up Docker Hub credentials:
37+
38+ 1 . Create or log in to your Docker Hub account at [ hub.docker.com] ( https://hub.docker.com/ )
39+ 2 . Create an access token under Account Settings > Security
40+ 3 . Add these secrets to your GitHub repository:
41+ - ` DOCKER_USERNAME ` : Your Docker Hub username
42+ - ` DOCKER_PASSWORD ` : Your Docker Hub access token
43+
44+ ### 3. ` GITHUB_TOKEN `
3345
3446This is automatically provided by GitHub Actions, so you don't need to configure it manually.
3547
36- ## Docker Hub Configuration (Optional)
48+ ## Docker Hub Configuration
3749
38- If you want to publish to Docker Hub instead of or in addition to GitHub Container Registry :
50+ Before your first release, make sure to :
3951
40- 1 . Create a Docker Hub access token
41- 2 . Add ` DOCKER_USERNAME ` and ` DOCKER_PASSWORD ` secrets to GitHub
42- 3 . Modify the docker.yml workflow to use Docker Hub
52+ 1 . Create a repository named ` watercrawl/mcp ` on Docker Hub
53+ 2 . Set appropriate visibility and description for your Docker image
54+ 3 . Verify that your Docker Hub user has push permissions for this repository
4355
4456## Configuring npm for Scoped Package
4557
@@ -71,16 +83,16 @@ Include `BREAKING CHANGE:` in the commit body or footer to trigger a major versi
7183
7284## Docker Usage
7385
74- The Docker image is built automatically and published to GitHub Container Registry .
86+ The Docker image is built automatically and published to Docker Hub .
7587
7688To use the Docker image:
7789
7890``` bash
7991# Pull the image
80- docker pull ghcr.io/ watercrawl/watercrawl- mcp:latest
92+ docker pull watercrawl/mcp:latest
8193
8294# Run the container
83- docker run -p 3000:3000 -e WATERCRAWL_API_KEY=your-api-key ghcr.io/ watercrawl/watercrawl- mcp:latest
95+ docker run -p 3000:3000 -e WATERCRAWL_API_KEY=your-api-key watercrawl/mcp:latest
8496
8597# Or use docker-compose
8698docker-compose up
0 commit comments