Skip to content

Commit f989e7b

Browse files
docs: add docker build instruction (#2096)
* docs: add docker build instruction * Apply suggestions from code review Co-authored-by: Sai Kumar <17549398+gsk967@users.noreply.github.com> --------- Co-authored-by: Sai Kumar <17549398+gsk967@users.noreply.github.com>
1 parent 225cd45 commit f989e7b

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,18 @@ To install the `umeed` binary:
8787
$ make build
8888
```
8989

90+
### Docker build
91+
92+
```bash
93+
docker build -t umee-network/umeed -f contrib/images/umeed.dockerfile .
94+
95+
# start bash
96+
docker run -it --name umeed umee-network/umeed bash
97+
98+
# or start the start the node if you already have a node directory setup
99+
docker run -it --name umeed umee-network/umeed umeed start
100+
```
101+
90102
### Recommended Database Backend
91103

92104
We recommend to use RocksDB. It requires to install `rocksdb` system libraries.
@@ -114,18 +126,18 @@ db_backend = "rocksdb"
114126

115127
Generate the latest swagger:
116128

117-
```bash
118-
$ make proto-swagger-gen
119-
$ make proto-update-swagger-docs
120-
```
129+
```bash
130+
$ make proto-swagger-gen
131+
$ make proto-update-swagger-docs
132+
```
121133

122134
Build the new binary or install the new binary with the latest swagger docs:
123135

124-
```bash
125-
$ make build
126-
# or
127-
$ make install
128-
```
136+
```bash
137+
$ make build
138+
# or
139+
$ make install
140+
```
129141

130142
Make sure to execute these commands whenever you want to update the swagger documentation.
131143

0 commit comments

Comments
 (0)