External/grumble
1
0
Fork 1
mirror of https://github.com/mumble-voip/grumble.git synced 2025-12-19 21:59:59 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge PR #60: Update README.

Browse source
This commit is contained in:
Davide Beatrici 2020-04-12 01:01:36 +02:00 • committed by GitHub
commit 362167ea3f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -1,7 +1,7 @@
Linux CI (Travis CI): Linux CI (Travis CI):
[![Build Status](https://travis-ci.com/mumble-voip/grumble.svg?branch=master)](https://travis-ci.org/mumble-voip/grumble) [![Build Status](https://travis-ci.com/mumble-voip/grumble.svg?branch=master)](https://travis-ci.com/mumble-voip/grumble)
Windows CI (AppVeyor): Windows CI (AppVeyor):
@ -23,18 +23,21 @@ https://golang.org/dl/
Once Go is installed, you should set up a GOPATH to avoid clobbering your Go environment's root directory with third party packages. Once Go is installed, you should set up a GOPATH to avoid clobbering your Go environment's root directory with third party packages.
Set up a GOPATH. On Unix, do something like this Set up a GOPATH. On Unix, do something like this
```shell script
$ export GOPATH=$HOME/gocode $ export GOPATH=$HOME/gocode
$ mkdir -p $GOPATH $ mkdir -p $GOPATH
```
and on Windows, do something like this (for cmd.exe): and on Windows, do something like this (for cmd.exe):
```shell script
c:\> set GOPATH=%USERPROFILE%\gocode c:\> set GOPATH=%USERPROFILE%\gocode
c:\> mkdir %GOPATH% c:\> mkdir %GOPATH%
```
Then, it's time to install Grumble. The following line should do the trick: Then, it's time to install Grumble. The following line should do the trick:
```shell script
$ go get mumble.info/grumble/cmd/grumble $ go get mumble.info/grumble/cmd/grumble
```
And that should be it. Grumble has been built, and is available in $GOPATH/bin as 'grumble'. And that should be it. Grumble has been built, and is available in $GOPATH/bin as 'grumble'.
@ -61,29 +64,32 @@ Docker
## Getting the image ## Getting the image
### Building ### Building
```shell script
$ git clone https://github.com/mumble-voip/grumble.git $ git clone https://github.com/mumble-voip/grumble.git
$ cd grumble/ $ cd grumble/
$ docker build -t mumble-voip/grumble . $ docker build -t mumble-voip/grumble .
```
## Running ## Running
### Command line ### Command line
```shell script
$ docker run \ $ docker run \
-v $HOME/.grumble:/data \ -v $HOME/.grumble:/data \
-p 64738:64738 \ -p 64738:64738 \
-p 64738:64738/udp \ -p 64738:64738/udp \
mumble-voip/grumble mumble-voip/grumble
```
### Compose ### Compose
```yaml
version: '3' version: '3'
services: services:
grumble: grumble:
image: mumble-voip/grumble image: mumble-voip/grumble
ports: ports:
- 64738:64738 - 64738:64738
- 64738:64738/udp - 64738:64738/udp
volumes: volumes:
- $HOME/.grumble:/data - $HOME/.grumble:/data
```