Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mumble-voip/grumble.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrim Kriegor <grimkriegor@krutt.org>2019-01-30 05:00:49 +0300
committerGrim Kriegor <grimkriegor@krutt.org>2019-01-30 05:00:49 +0300
commit89a19acd5aa97d5b038b99567b6ded7bef13ccf6 (patch)
tree701ee87036b319ce6920fcec29c0dd5429215bca /README.md
parent41f8b391e475199a376f3f5040cf4828d64af806 (diff)
Docker: add initial support
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5d9e93c..2c5c982 100644
--- a/README.md
+++ b/README.md
@@ -54,3 +54,36 @@ It is architected this way because it allowed me to write a pure-Go program with
The current thinking is that if registered users are taking up too much of your memory, you should use an external authenticator. But that code isn't written yet. The concept would be equivalent to Murmur's authenticator API via RPC. But a Grumble authenticator would probably be set up more akin to a webhook -- so just a URL in the config file.
Then there's the API problem. You can't currently remote control Grumble. Which can make it hard to use in production. I imagine Grumble will grow an API that it makes available via HTTP. Murmur's API is already quite stateless in many regards, so it shouldn't be too much of a stretch to put a RESTful API in Grumble to do the same job.
+
+Docker
+==============
+
+## Getting the image
+
+### Building
+
+ $ git clone https://github.com/mumble-voip/grumble.git
+ $ cd grumble/
+ $ docker build -t mumble-voip/grumble .
+
+## Running
+
+### Docker CLI
+
+ $ docker run \
+ -v $HOME/.grumble:/data \
+ -p 64738:64738
+ -p 64738:64738/udp
+ mumble-voip/grumble
+
+### Compose
+
+ version: '3'
+ services:
+ grumble:
+ image: mumble-voip/grumble
+ ports:
+ - 64738:64738
+ - 64738:64738/udp
+ volumes:
+ - $HOME/.grumble:/data