Skip to content

Commit b6ebf3b

Browse files
johnitvnjohnitvn
committed
docs: update documentation
1 parent ef4826e commit b6ebf3b

File tree

5 files changed

+135
-3
lines changed

5 files changed

+135
-3
lines changed

‎README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ This project is mainly used internally within ebizbase projects but we have deci
4040
| Name | Description |
4141
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
4242
| [node-distroless][node-distroless-readme] | This image combines the compactness and security of distroless with the convenience of dumb-init for process management, making Node.js applications run more stably in a container environment. |
43-
| [nginx-spa][node-distroless-readme] | This docker image can be used for single page apps. It serves your index.html if no other file matches. |
43+
| [nginx-spa][node-distroless-readme] | This docker image can be used for single page apps. It serves your index.html if no other file matches. |
44+
| [mongodev][mongodev-readme] | This image include mongodb with replicate set mode with only one node and mongo-express for UI manager tool. |
45+
| [redisdev][redisdev-readme] | This image include redis and redis-commander for UI manager tool. |
4446

4547
### npm packages
4648

@@ -103,3 +105,5 @@ Distributed under the MIT License. See [LICENSE][license-url] for more informati
103105
[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md
104106
[node-distroless-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/node-distroless/README.md
105107
[nginx-spa-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/nginx-spa/README.md
108+
[mongodev-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/mongodev/README.md
109+
[redisdev-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/redisdev/README.md

‎images/mongodev/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# mongodev
2+
3+
mongodev is a Docker image designed to create a MongoDB environment with a replica set mode using only a single node, allowing you to quickly set up development infrastructure. This image include UI manager tool (mongo-express) too.
4+
5+
> This image is maintained with node latest stable mongo and mongo-express
6+
7+
## Usage
8+
9+
```yaml
10+
services:
11+
your-service:
12+
build:
13+
context: .
14+
dockerfile: Dockerfile
15+
container_name: your-service
16+
MONGO_CONNECTION_STRING: mongodb://mongodev:27017/?directConnection=true&tls=false
17+
command: ${your app run command}
18+
depends_on:
19+
- mongodev
20+
mongodev:
21+
image: mongodev:latest
22+
container_name: mongodev
23+
ports:
24+
- "8081:8081"
25+
```
26+
27+
Simply run your containers as follows:
28+
29+
```shell
30+
docker compose up -d
31+
```
32+
33+
Now you can visit http://localhost:8081/ in your browser to access mongo-express
34+
35+
36+
37+
## Contributing
38+
39+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
40+
41+
## Issues
42+
43+
If you encounter any issues while using this feature, please check the following before creating a new issue:
44+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
45+
46+
If the issue persists, feel free to:
47+
48+
- Open an issue on the [GitHub issues page][issues-url]
49+
- Provide detailed information, including:
50+
- A description of the issue.
51+
- Steps to reproduce the problem.
52+
- Logs or error messages, if applicable.
53+
- Your devcontainer setup (e.g., OS, DevContainer version).
54+
55+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
56+
57+
58+
## License
59+
60+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
61+
62+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
63+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
64+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt

‎images/mongodev/project.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"namespace": "ebizbase/mongodev",
1212
"labels": {
1313
"org.opencontainers.image.source": "https://github.com/ebizbase/dev-infras",
14-
"org.opencontainers.image.description": "Mongodb development image with mongo and mongo-express",
14+
"org.opencontainers.image.description": "MongoDB with replicate set mode with only one node and mongo-express is UI manager tool",
1515
"org.opencontainers.image.licenses": "MIT"
1616
}
1717
},

‎images/redisdev/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# redisdev
2+
3+
redisdev is a Docker image designed to create a Redis environment with ease, allowing you to quickly set up development infrastructure. This image also includes a UI management tool (redis-commander) for convenient database management.
4+
5+
> This image is maintained with node latest stable redis and redis-commander
6+
7+
## Usage
8+
9+
```yaml
10+
services:
11+
your-service:
12+
build:
13+
context: .
14+
dockerfile: Dockerfile
15+
container_name: your-service
16+
REDIS_HOST: redisdev
17+
REDIS_PORT: 6379
18+
command: ${your app run command}
19+
depends_on:
20+
- redisdev
21+
redisdev:
22+
image: redisdev:latest
23+
container_name: redisdev
24+
ports:
25+
- "8081:8081"
26+
```
27+
28+
Simply run your containers as follows:
29+
30+
```shell
31+
docker compose up -d
32+
```
33+
34+
Now you can visit http://localhost:8081/ in your browser to access redis-commander
35+
36+
37+
## Contributing
38+
39+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
40+
41+
## Issues
42+
43+
If you encounter any issues while using this feature, please check the following before creating a new issue:
44+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
45+
46+
If the issue persists, feel free to:
47+
48+
- Open an issue on the [GitHub issues page][issues-url]
49+
- Provide detailed information, including:
50+
- A description of the issue.
51+
- Steps to reproduce the problem.
52+
- Logs or error messages, if applicable.
53+
- Your devcontainer setup (e.g., OS, DevContainer version).
54+
55+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
56+
57+
58+
## License
59+
60+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
61+
62+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
63+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
64+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt

‎images/redisdev/project.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"namespace": "ebizbase/redisdev",
1212
"labels": {
1313
"org.opencontainers.image.source": "https://github.com/ebizbase/dev-infras",
14-
"org.opencontainers.image.description": "Redis development image with redis and redis-commander",
14+
"org.opencontainers.image.description": "Redis with redis-commander is UI manager tool",
1515
"org.opencontainers.image.licenses": "MIT"
1616
}
1717
},

0 commit comments

Comments
 (0)