From 91f446c6fe72e6f26d2f53cfb5c96aaa2a8a79a3 Mon Sep 17 00:00:00 2001 From: Josh Proehl Date: Thu, 30 Mar 2023 18:13:51 -0500 Subject: [PATCH 1/5] Document make install env variable issue --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a90b421..a4bf52a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,11 @@ make make -f MakefileGUI #only required if you want to build the GUI programs sudo make install ``` +Note that you may need to use `sudo -E make install` to pass the environment variables, or just `sudo TARGET=opendv make install` to correctly create the opendv user/directories, depending on your system configuration. + Now you should edit the configuration in the file /etc/ircddbgateway to match your needs. + +When building in TARGET=opendv mode, the necessary systemd unit files will be installed. To ensure ircddbgatewayd starts at system boot, and then immediately start it, use: ```shell sudo systemctl enable ircddbgatewayd.service #enable service sudo service ircddbgatewayd start From 9c82738c5a7ef4e20cbe9720d60bdbc68b700a15 Mon Sep 17 00:00:00 2001 From: Josh Proehl Date: Fri, 31 Mar 2023 12:41:29 -0500 Subject: [PATCH 2/5] Only cp default conf if file doesn't already exist closes #75 --- ircDDBGateway/Makefile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ircDDBGateway/Makefile b/ircDDBGateway/Makefile index 6118f46..28589c3 100644 --- a/ircDDBGateway/Makefile +++ b/ircDDBGateway/Makefile @@ -15,7 +15,9 @@ ircddbgatewayd: $(OBJECTS) ../ircDDB/IRCDDB.a ../Common/Common.a .PHONY: install install: install -g root -o root -m 0755 ircddbgatewayd $(DESTDIR)$(BINDIR) +ifeq (,$(wildcard $(DESTDIR)$(CONFDIR)/ircddbgateway)) cp ircddbgateway-emptyconfig $(DESTDIR)$(CONFDIR)/ircddbgateway +endif ifeq ($(TARGET), opendv) cp ../debian/ircddbgatewayd.ircddbgatewayd.service $(DESTDIR)/etc/systemd/system/ircddbgatewayd.service endif From 5b425971b5430aaef2064decec30fed93fd19c7f Mon Sep 17 00:00:00 2001 From: Josh Proehl Date: Thu, 30 Mar 2023 18:33:46 -0500 Subject: [PATCH 3/5] Add make uninstall --- Makefile | 16 ++++++++++++++++ README.md | 2 ++ 2 files changed, 18 insertions(+) diff --git a/Makefile b/Makefile index 067f0b1..e5af598 100644 --- a/Makefile +++ b/Makefile @@ -105,6 +105,22 @@ clean: $(MAKE) -C VoiceTransmit clean $(MAKE) -C ircDDBGatewayConfig clean +.PHONY: uninstall +uninstall: +ifeq ($(TARGET), opendv) + userdel opendv || true + rm -r /var/log/opendv || true +endif + rm -r $(DESTDIR)$(DATADIR) || true + rm $(DESTDIR)$(BINDIR)/aprstransmitd || true + rm $(DESTDIR)$(BINDIR)/ircddbgatewayd || true + rm $(DESTDIR)$(BINDIR)/remotecontrold || true + rm $(DESTDIR)$(BINDIR)/starnetserverd || true + rm $(DESTDIR)$(BINDIR)/texttransmitd || true + rm $(DESTDIR)$(BINDIR)/timercontrold || true + rm $(DESTDIR)$(BINDIR)/timeserverd || true + @echo "*** NOTE: Leaving /etc/ircddbgateway in place ***" + .PHONY: force force : @true diff --git a/README.md b/README.md index a4bf52a..14b034f 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,5 @@ When building in TARGET=opendv mode, the necessary systemd unit files will be in sudo systemctl enable ircddbgatewayd.service #enable service sudo service ircddbgatewayd start ``` + +If you wish to remove the manually installed files you may use `sudo make uninstall` From 59a7d1ab1ed5577747f33a6407a65b785e23a895 Mon Sep 17 00:00:00 2001 From: Josh Proehl Date: Thu, 30 Mar 2023 20:47:57 -0500 Subject: [PATCH 4/5] Document systemctl, delete systemd unit on uninstall --- Makefile | 1 + README.md | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index e5af598..b3610d3 100644 --- a/Makefile +++ b/Makefile @@ -110,6 +110,7 @@ uninstall: ifeq ($(TARGET), opendv) userdel opendv || true rm -r /var/log/opendv || true + rm $(DESTDIR)/etc/systemd/system/ircddbgatewayd.service endif rm -r $(DESTDIR)$(DATADIR) || true rm $(DESTDIR)$(BINDIR)/aprstransmitd || true diff --git a/README.md b/README.md index 14b034f..b030271 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,12 @@ Now you should edit the configuration in the file /etc/ircddbgateway to match yo When building in TARGET=opendv mode, the necessary systemd unit files will be installed. To ensure ircddbgatewayd starts at system boot, and then immediately start it, use: ```shell -sudo systemctl enable ircddbgatewayd.service #enable service +sudo systemctl enable ircddbgatewayd.service sudo service ircddbgatewayd start ``` -If you wish to remove the manually installed files you may use `sudo make uninstall` +If you wish to remove the manually installed files you may use `sudo make uninstall`. +Note that this will remove the systemd unit, but will not first stop or disable the service. To do so, first use: +```shell +sudo systemctl disable --now ircddbgateway.service +``` From bd3521716987b618b60ae7519c3c2b75a89924a5 Mon Sep 17 00:00:00 2001 From: Josh Proehl Date: Thu, 30 Mar 2023 20:48:28 -0500 Subject: [PATCH 5/5] Add setup documention (mostly ICOM repeater related) --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index b030271..f54c25b 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,28 @@ Note that this will remove the systemd unit, but will not first stop or disable ```shell sudo systemctl disable --now ircddbgateway.service ``` +It will also not remove your /etc/ircddbgateway configuration file. + +# Setup + +Only the ircddbgatewayd service is required for basic usage, all other compiled applications are optional. + +## ICOM repeater configuration +If using an ICOM ID-RP2C you will need to use the ICOM utility to configure the repeater. By default the ID-RP2C uses the IP address 172.16.0.1, and expects the device controlling it (either your computer, or the computer running ircddbgatewayd) to be using the IP address 172.16.0.20, and uses the default password "PASSWORD". It may not be advisable to change this password as performing a hardware reset is not a documented feature. Ideally the ID-RP2C is connected directly to a secondary ethernet port on the device running ircddbgatewayd and configured with a static IP address, other configurations may prove problematic. + +When configuring the repeater using the ICOM utility you will need to change the port in the "Communication Settings" section to use the same port as is used in the "Gateway" section (20000 by default), and then go into the Options/Network Setup menu of the ICOM app to change the port to match what you put into the "Communication Settings" section. + +Once both of those fields are set to the same port number, ensure that the "Local RPT" section is set correctly for whichever physical plug your ID-RP2D is plugged into on the back of the ID-RP2C. Whichever number you have plugged in to should be set to "Voice", and have the correct band entered in the text box. ("B" for 70cm, for example.) + +In your /etc/ircddbgateway config file the following options are important: +``` +icomAddress=172.16.0.20 +icomPort=20000 +repeaterCall1=REPEATERCALLSIGN +repeaterBand1=B +repeaterType1=1 +repeaterAddress=172.16.0.1 +repeaterPort1=20000 +``` +Note that this assumes you're configuring "Repeater 1". +The repeaterAdress is the address of the ID-RP2C controller, and "icomAddress" is the address of the device running ircddbgatewayd. The "Type" being 1 indicates an ICOM repeater. The Band should be set to whichever band you entered in the "Local RPT" section of the ICOM configuration software, and the callsign should match the call used in in the ICOM software.