Skip to content

Commit

Permalink
change README based on PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam-Bate-ITV committed Dec 9, 2024
1 parent 812452b commit 1f93cb7
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ jobs:
- name: Start MongoDB
uses: supercharge/[email protected]
with:
# Here we are using an image from Amazon's ECR rather than the default image from Docker Hub
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}

- run: npm install
Expand Down Expand Up @@ -248,6 +246,17 @@ jobs:

**Caveat:** due to [this issue](https://github.com/docker-library/mongo/issues/211), you **cannot enable user creation AND replica sets** initially. Therefore, if you use this action to setup a replica set, please create your users through a separate script.

### Using a Custom Mongo Image
You can utilize an alternative Redis image using the `mongodb-image` input:

```yaml
- name: Start MongoDB
uses: supercharge/[email protected]
with:
# Here we are using an image from Amazon's ECR rather than the default image from Docker Hub
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}
```

## License
MIT © [Supercharge](https://superchargejs.com)
Expand Down

0 comments on commit 1f93cb7

Please sign in to comment.