Skip to content

Commit 5f64583

Browse files
authored
Update README.md
1 parent 8f76442 commit 5f64583

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ go install github.com/looterz/grimd@latest
1313

1414
You can also download one of the [releases](https://github.com/looterz/grimd/releases) or [docker images](https://github.com/looterz/grimd/pkgs/container/grimd). Detailed guides and resources can be found on the [wiki](https://github.com/looterz/grimd/wiki).
1515

16+
# Docker Installation
17+
To quickly get grimd up and running with docker, run
18+
```
19+
docker run -d -p 53:53/udp -p 53:53/tcp ghcr.io/looterz/grimd:latest
20+
```
21+
1622
# Configuration
1723
If ```grimd.toml``` is not found, it will be generated for you, below is the default configuration.
1824
```toml
@@ -117,17 +123,17 @@ Requires golang 1.7 or higher, you build grimd like any other golang application
117123
env GOOS=linux GOARCH=amd64 go build -v github.com/looterz/grimd
118124
```
119125

120-
# Docker
126+
# Building Docker
121127
Run container and test
122128
```shell
123129
mkdir sources
124130
docker build -t grimd:latest . && \
125131
docker run -v $PWD/sources:/sources --rm -it -P --name grimd-test grimd:latest --config /sources/grimd.toml --update
126132
```
127133

128-
For Mac docker, must set 'api = "0.0.0.0:8080"' instead of 'api = "127.0.0.1:8080"' to get networking correct
134+
For Mac docker set `'api = "0.0.0.0:8080"'` instead of `'api = "127.0.0.1:8080"'`.
129135
```shell
130-
curl -H "Accept: application/json" http://127.0.0.1:55006/application/active
136+
curl -H "Accept: application/json" http://127.0.0.1:55006/application/active
131137
```
132138

133139
# Web API

0 commit comments

Comments
 (0)