ShaYmez
/
HomebrewDocker
mirror of https://github.com/ShaYmez/HomebrewDocker.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

set udp params for docker, updated readme

This commit is contained in:
Dylan Ambauen 2017-12-11 20:35:37 -08:00
parent 24b1155810
commit 8d3a973fe6
2 changed files with 68 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Dockerfile
View File

@ -21,7 +21,7 @@ COPY IPSC_Bridge.cfg /opt/dmrlink/bridge/ISPC_Bridge.cfg
EXPOSE 55555
EXPOSE 55555/udp
CMD ["/usr/bin/supervisord"]

129
README.md
View File

@ -1,89 +1,94 @@
DMR Homebrew Server with IPSC Bridge
===============================
## Dockerfile
This Dockerfile packages up some great code the other people wrote:
- dmrlink by N0MJS, IPSC_Bridge branch, https://github.com/n0mjs710/DMRlink/tree/IPSC_Bridge
- hblink by N0MJS, HB_Brige branch, https://github.com/n0mjs710/HBlink/tree/HB_Bridge
This Dockerfile packages up some great code that other people wrote.
- IPSC_Bridge branch of dmrlink by N0MJS, https://github.com/n0mjs710/DMRlink
- HB_Bridge branch of hblink by N0MJS, https://github.com/n0mjs710/HBlink
- ipscbuild by Vance w6ss@dx40.com
- Debian Jessie-Slim, etc.
Please read more about IPSC_Bridge and HB_Bridge before attempting to use them. This documentation is just really barely enough to let a knowledgable user follow steps to get it running. Please see the respective softwares for their documentation.
Docker is best at running a single application. In this case, we wanted to run 2 applications.
Supervisord is employed to run HB_Bridge and IPSC_Bridge, Docker thinks we're just running Supervisor.
N0MJS makes a particular note:
> The configuration file for dmrlink is in ".ini" format, and is self-documented. A warning not in the self-documentation: Don't enable features you do not undertand, it can break dmrlink or the target IPSC (nothing turning off dmrlink shouldn't fix). There are options avaialble because the IPSC protocol appears to make them available, but dmrlink doesn't yet understand them. For exmaple, dmrlink does not process XNL/XCMP. If you enable it, and other peers expect interaction with it, the results may be unpredictable. Chances are, you'll confuse applications like RDAC that require it. The advantage to dmrlink not processing XNL/XCMP is that it also cannot "brick" a repeater or subscriber, since all of these dangerous features use XNL/XCMP.
Supervisord is employed to run HB_Bridge and IPSC_Bridge, we tell Docker just to run Supervisor.
## Why Docker?
The goal in containerizing the HB+IPSC pair is to simplify running multiple instances on a single server. You can install these applications directly. Docker is pretty cool. Once you get used to it, you may find all sorts of things to use containers for.
Docker has great documentation online. https://docs.docker.com
## Config
Before you begin, you must edit the configuration files.
## Required Config
You must edit these configurations, then build your Docker image. The build process defined in the Dockerfile will copy your edited files into the new image.
Anytime you edit these config files, you'll want to build a new image. Use a different tag every time you build. Docker keeps a cache of the build process. The first build will run slowly. But rebuilding just to copy the new config will run very quickly. You'll see Docker's output when you try it. Examples below.
### Dockerfile
You probably do not need to edit this file, even if you want to run multiple instances. Nor do you need to edit this file to change the port clients use to connect to your MMDVM server.
`EXPOSE <port>/udp` in Dockerfile, should match the port where your HB_Bridge master is listening, inside the container. For example, this snippet from hblink.cfg.
I want hotspots to connect to my MMDVM server at udp port 4567. Ok,
### hblink.cfg
Defines parameters for homebrew.
Master means: open a port and wait for HB clients to connect. Your hotspot
(Pi-Star or openSpot, etc) will connect here. The default port is 55555/udp.
Docker requires an additional layer of port mapping, so be sure to
connect to your exposed port.
Settings for your MMDVM Server go in this file.
To run a MMDVM server, specify a Master. Leave the port at 55555, clients will never see it. You'll get to choose what port clients will connect to, later, with `docker run -p OUTSIDE:55555/udp` in the next section.
[<YOURCALL>-MMDVMServer-1]
MODE: MASTER
ENABLED: True
REPEAT: True
EXPORT_AMBE: False
IP:
PORT: 55555
PASSPHRASE: changeme
GROUP_HANGTIME: 1
### HB_Bridge.cfg
Defines AMBE ports for talking to IPSC_Bridge.
Also, defines the talkgroup deck.
Defines the talkgroup deck. NO7RF knows more about this.
Also, defines internal ports for talking to IPSC_Bridge.
Must match the same (inverted) settings in IPSC_Bridge.cfg. Might as well leave the defaults alone. The ports are arbitrary, and entirely contained within the runtime container. You may run multiple instances of the same docker image without any port conflicts.
### dmrlink.cfg
Defines parameters for IPSC master and peers.
If you have a cBridge, use it as an IPSC master.
Defines parameters for IPSC master and peers. If you have a cBridge, use it as an IPSC peer. The software author m
### IPSC_Bridge.cfg
Settings paired (inverted) from HB_Bridge.cfg. HB_Bridge and IPSC_Bridge will use these 2 ports to communicate.
### Other Config
supervisord.conf
Don't bother editing this one. Settings paired (inverted) from HB_Bridge.cfg. HB_Bridge and IPSC_Bridge will use these ports to communicate.
# Build
## Clone a copy of the Dockerfile
git clone https://github.com/KI7SBI/HomebrewDocker.git
## Edit your config files
cd HomebrewDocker
nano ...
## Build the Dockerfile
When you run the following build command, config files are copied into the docker image.
Name:Tag can be set to any value you wish.
sudo docker build -t HBIPSCDocker:config1
### supervisord.conf
edit if you wish, really just glue to running 2 programs within a container
## Multiple copies or versions
Edit config files, and build again, using a different tag. For example,
sudo docker build -t HBIPSCDocker:pnwdigital
## Build and Run
We're going to run two copies. We want different talkgroup decks A and B on separate HB servers. This implies two, different IPSC connections.
git clone https://github.com/KI7SBI/HomebrewDocker.git MMDVM-A
git clone https://github.com/KI7SBI/HomebrewDocker.git MMDVM-B
Now, go edit your config files.
Next step is to build a docker image. `docker build -t REPOSITORY:TAG`
Notice how Docker reuses cached build images to build your second version in no time at all.
cd MMDVM-A
sudo docker build -t mmdvm:server-a
cd ../MMDVM-B
sudo docker build -t mmdvm:server-b
sudo docker run -d -p 50001:55555/udp mmdvm:server-a
sudo docker run -d -p 50002:55555/udp mmdvm:server-b
#Run
Remember to map exposed ports.
sudo docker run -d -p 50001:55555 HBIPSCDocker:config1
sudo docker run -d -p 50002:55555 HBIPSCDocker:pnwdigital
# Connect your hotspot
Hotspots in MMDVM Server mode may connect to your port 50001 to use config1 bridge settings.
Or, connect to 50002 to use pnwdigital bridge settings.
# Manage Docker Instances
docker ps
docker images
docker kill
#Why Docker?
Yes, docker has a learning curve. It may seem unnecessary for you, and perhaps it is in your case.
The goal in containerizing the HB+IPSC pair is primarily to simplify running multiple instances on a single server.
If you dont care to run multiple instances, then you may always just install these apps directly.
## Connect your hotspot
From the outside, clients can connect to 50001 or 50002.