Skip to content

Commit

Permalink
Update README and Dockerfile
Browse files Browse the repository at this point in the history
  • Loading branch information
Clivern committed Jan 9, 2019
1 parent 631a6cc commit c09a7a3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 18 deletions.
4 changes: 0 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
FROM golang:1.11.1

RUN curl https://raw.githubusercontent.com/golang/dep/v0.5.0/install.sh | sh

RUN mkdir -p /go/src/github.com/clivern/beaver/

ADD . /go/src/github.com/clivern/beaver/

WORKDIR /go/src/github.com/clivern/beaver

RUN dep ensure

RUN go build -o beaver beaver.go

EXPOSE 8080
Expand Down
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,7 @@ Beaver is a real-time messaging server. With beaver you can easily build scalabl

### Config & Run The Application

Beaver uses [dep](https://github.com/golang/dep) to manage dependencies so you need to install it

```bash
# For latest dep version
$ curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh

# For latest stable version
$ curl https://raw.githubusercontent.com/golang/dep/v0.5.0/install.sh | sh

$ dep ensure
```

Then Create a dist config file.
Beaver uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependencies. First Create a dist config file.

```bash
$ cp config.yml config.dist.yml
Expand Down Expand Up @@ -65,6 +53,13 @@ $ ./beaver -config=/custom/path/config.dist.yml
$ go run beaver.go -config=/custom/path/config.dist.yml
```

Or [download a pre-built Beaver binary](https://github.com/Clivern/Beaver/releases) for your operating system.

```bash
curl -sL https://github.com/Clivern/Beaver/releases/download/x.x.x/beaver_x.x.x_OS.tar.gz | tar xz
./beaver -config=config.dist.yml
```

Also running beaver with docker still an option.

```bash
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ services:
- 'redis_data:/data'
restart: always
web:
image: "clivern_beaver:1.0.0"
image: "clivern_beaver:1.1.0"
build: .
command: './beaver'
ports:
Expand Down

0 comments on commit c09a7a3

Please sign in to comment.