Skip to content

Commit 8aa4cb8

Browse files
committed
Create README.md
1 parent acbf47a commit 8aa4cb8

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

Diff for: README.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Docker ElasticSearch Kibana MongoDB Monstache
2+
3+
Ready to use for development purposes docker-compose project with one-command deployment.
4+
Autosync everything from MongoDB to ElasticSearch using [MongoDB Change stream](https://www.mongodb.com/docs/manual/changeStreams/).
5+
All settings are put in `.env` file for easy customization.
6+
7+
## Getting Started
8+
9+
To run this project all you need is to clone code and have docker-compose installed.
10+
11+
### Installing
12+
13+
```
14+
$ git clone https://github.com/akdev-tech/docker-elastic-monstache.git
15+
$ cd docker-elastic-monstache
16+
```
17+
18+
After that you may change .env file containing hostnames, usernames, passwords and Monstache config.
19+
20+
### Running
21+
22+
```
23+
$ docker-compose up -d
24+
```
25+
26+
## Default configuration
27+
28+
### MongoDB
29+
30+
Is deployed in single-node replicaSet configuration
31+
32+
http://127.0.0.1:27017?replSet=dbrs
33+
34+
35+
Root user credentials:
36+
`root` `rootpassword`
37+
38+
39+
User credentials:
40+
`username` `password`
41+
42+
43+
### ElasticSearch
44+
45+
http://127.0.0.1:9200
46+
47+
48+
User credentials:
49+
`elastic` `elasticpass`
50+
51+
52+
### Kibana web interface
53+
54+
http://127.0.0.1:5601
55+
56+
57+
User credentials:
58+
`elastic` `elasticpass`
59+
60+
61+
### Please draw attention
62+
63+
Initialization of MongoDB replica set is performed with docker-compose `healthcheck` directive, so you may see errors in startup logs for the first time. It is done this way to avoid routine logging in console and executing the initialization command.
64+
65+
This project should be used only in development purposes.
66+
67+
68+
## Built With These Docker Images
69+
70+
* [MongoDB](https://hub.docker.com/_/mongo)
71+
* [ElasticSearch](https://hub.docker.com/_/elasticsearch)
72+
* [Kibana](https://hub.docker.com/_/kibana)
73+
* [Monstache](https://hub.docker.com/r/rwynn/monstache)
74+
75+
76+
## License
77+
78+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
79+
80+
## Acknowledgments
81+
82+
* Startup logs containing errors for the first run (until replicaSet is initialized)
83+
* `docker-compose ps` shows `unhealthy` status for mongodb

0 commit comments

Comments
 (0)