F4KXL_DStarGateway/README.md

• 1. Introduction
• 2. Current State
  • 2.1. Code sanity
  • 2.2. Code Credit
  • 2.3. Features
• 3. Building and installing
  • Get latest stable code
  • 3.1. Prerequisites and dependencies
  • 3.2. Building
  • 3.3. Installing
  • 3.4. Configuring
• 4. Version History
  • 4.1. v0.1

1. Introduction

This is a port of G4KLX Jonathan Naylor's ircddbGateway. It is wxWidgets free and has minimal dependencies to boost (header libs only), libconfig++ and libcurl

2. Current State

2.1. Code sanity

The current code is working, yet ugly IMHO as it is a mix of C and C++ of various ages.

The code has also been amended to no longer rely on compiler defines for paths like log or data. These can be set in configuration file.

Quite a few classes are more or less copy/paste from each other some sanitization by using base classes or template classes would greatly improve code maintainibility.

2.2. Code Credit

• Jonathan Naylor G4KLX (The original author of ircddbGateway)
• Thomas A. Early N7TAE (Code taken from his smart-group software)
• Geoffrey Merck F4FXL / KC3FRA That's me !

2.3. Features

All the features found in ircddbGateway are supposed to be working. I have mixed feelings about putting these back in or not.

Features that where left out :

• CCS: is still being used? I always considered this as trojan horse to push some DMR Agenda into DStar an more or les a burdain to use. Call sign routing is by far more flexible and superior.
• Starnet: You might consider running Smart Group Server XL from a dedicated computer instead.
• Announcement: same can be achieved using transmitd.
• APRSGateway capability: I would prefer to have some sort of TCP "APRS-IS proxy" program sitting between the program and the APRS server, thus keeping the ability to directly connect to APRS-IS or not.
• Mobile APRS: Code has been ported, yet I am targeting repeaters so low priority.

3. Building and installing

Get latest stable code

From inside the already cloned repository run following commands

git fetch --tags
latestTag=$(git describe --tags `git rev-list --tags --max-count=1`)
git checkout $latestTag

3.1. Prerequisites and dependencies

Before first time building you need to install dependencies and prerequisites

apt install build-essential libconfig++-dev libcurl4-openssl-dev libboost-dev

3.2. Building

make

3.3. Installing

The program is meant to run as a systemd service. All bits an pieces are provided.

sudo make install

3.4. Configuring

After installing you have to edit the configuration file. If you went with default paths, the config file is located in /usr/local/etc/dstargateway.cfg The syntax is libconfig syntax, keep in my mind that configuration keys are case sensitive. When done with configuration, the daemon will be started automatically on boot. To manual start and stop it use the usual systemd commands

sudo systemctl start dstargateway.service
sudo systemctl stop dstargateway.service

4. Version History

4.1. v0.1

First working version