Skip to content

Commit 26462e7

Browse files
committed
Installation instructions are more complete
1 parent 5b499ba commit 26462e7

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Message DB](http://docs.eventide-project.org/message-db-logo-90x105.png)
2+
13
# Message DB
24

35
**Microservice Native Event Store and Message Store for Postgres**
@@ -18,6 +20,38 @@ For more information on the executables, see:
1820

1921
[http://docs.eventide-project.org/user-guide/message-db/tools.html](http://docs.eventide-project.org/user-guide/message-db/tools.html)
2022

23+
## Installation
24+
25+
``` bash
26+
gem install message-db
27+
```
28+
29+
## Create the Postgres Database
30+
31+
Running the database installation tool creates the database, schema, table, indexes, functions, views, types, a user role, and limit the user's privileges to the message store's public interface.
32+
33+
**Note: Make sure that your default Postgres user has administrative privileges.**
34+
35+
The database installation Ruby executable will be installed with the `message-db` gem. The executable will be in the gem executable search path and may also be executed through bundler:
36+
37+
``` bash
38+
bundle exec mdb-create-db
39+
```
40+
41+
For more information about Ruby executables installed with the `message-db` Ruby Gem, see the Eventide docs on the administration tools that are bundled with the gem:
42+
43+
[http://docs.eventide-project.org/user-guide/message-db/tools.html](http://docs.eventide-project.org/user-guide/message-db/tools.html)
44+
45+
### Database Name
46+
47+
By default, the database creation tool will create a database named `message_store`.
48+
49+
If you prefer either a different database name, you can override the name using the `DATABASE_NAME` environment variable.
50+
51+
``` bash
52+
DATABASE_NAME=some_other_database bundle exec mdb-create-db
53+
```
54+
2155
## Documentation
2256

2357
See the Message DB documentation on the Eventide docs site:

0 commit comments

Comments
 (0)