Last edited · 6 revisions  

 


HBlink.cfg Settings

This information is gleaned from the GitHub repository for HBlink.

[GLOBAL] - Systemwide Parameters

This section defines program-wide parameters and settings. Some of the keys in this section are reused elsewhere and may supersede these values in that circumstance.

PATH

This is the working path for files, you should leave it alone unless you NEED to change it

Default: PATH: ./

PING_TIME

Depending on whether you're configuring masters or peers, the behavior of this value is slightly different. The value is in seconds.

Master: determines how often (in seconds) the Master maintenance loop runs

Peer: the interval (in seconds) that peers will ping the master, and re-try registraion

Default: PING_TIME: 5

MAX_MISSED

As with PING_TIME, this parameter specifies behavior for both masters and peers.

Master: number of times the master maintenance loop runs before de-registering a peer

Peer: how many pings are missed before we give up and re-register

Default: MAX_MISSED: 3

Access Control Lists

Access Control Lists (ACLs) are used throughout the configuration file. You should be careful not to overuse them, as they can impact packet throughput. That said, they are a critical and flexible way to make sure you only get the traffic you want to see on your network.

USE_ACL

Default: USE_ACL: True

REG_ACL

Default: REG_ACL: PERMIT_ALL

SUB_ACL

Default: SUB_ACL: DENY:1

TGID_TS1_ACL

Default: TGID_TS1_ACL: PERMIT:ALL

TGID_TS2_ACL

Default: TGID_TS2_ACL: PERMIT:ALL

[REPORTS] - Network Reporting Parameters

REPORT

Default: REPORT: True

REPORT_INTERVAL

Default: REPORT_INTERVAL: 60

REPORT_PORT

Default: REPORT_PORT: 4321

REPORT_CLIENTS

Default: REPORT_CLIENTS: 127.0.0.1

[LOGGER] - System Logger Parameters

LOG_FILE

Default: LOG_FILE: /tmp/hblink.log

LOG_HANDLERS

Default: LOG_HANDLERS: console-timed

LOG_LEVEL

Default: LOG_LEVEL: DEBUG

LOG_NAME

Default: LOG_NAME: HBlink

[ALIASES] - ID lists from external sources

TRY_DOWNLOAD

Default: TRY_DOWNLOAD: True

PATH

Default: PATH: ./

PEER_FILE

Default: PEER_FILE: peer_ids.json

SUBSCRIBER_FILE

Default: SUBSCRIBER_FILE: subscriber_ids.json

TGID_FILE

Default: TGID_FILE: talkgroup_ids.json

PEER_URL

Default: PEER_URL: https://www.radioid.net/static/rptrs.json

SUBSCRIBER_URL

Default: SUBSCRIBER_URL: https://www.radioid.net/static/users.json

STALE_DAYS

Default: STALE_DAYS: 7

Instance Common Parameters

Identifiers

Should be relevant to what the role is. If it's a Master, it might do well to include "Master" in the identifier. For OpenBridge instances, we suggest that the master that the bridge is connecting with be included in the identifier. For peers, perhaps the callsign of the peer should be included in the identifier, such that when troubleshooting or examining logs, you can get a sense as to what is happening and which components are involved.

MODE

Required: MODE: OPENBRIDGE

ENABLED

Default: ENABLED: True

IP

Default: IP:

PORT

Default: PORT: 62035

PASSPHRASE

ACLs

OpenBridge Instances

NETWORK_ID

Default: NETWORK_ID: 3129100

TARGET_IP

Default: TARGET_IP: 1.2.3.4

TARGET_PORT

Default: TARGET_PORT: 62035

ACL Usage for OpenBridge Instances

Be aware that OpenBridge doesn't support peers per se, as it's a bridge between HBlink and a network like BrandMeister. It doesn't behave like a peer connection, so the concept of REG_ACL is not relevant in this section and any value set with that key will be ignored.

TGID_ACL

See the usage for this parameter above under [GLOBAL]. Since OpenBridge only deals with TS1, there is only one ACL for talk group ID's, hence the parameter name is different. Still, the ACL behaves the same as TGID_TS1_ACL as mentioned above.

Default: TGID_ACL: PERMIT:ALL

Master Instances

REPEAT

MAX_PEERS

GROUP_HANGTIME

ACL Usage for Master Instances

 

Peer Instances

LOOSE

MASTER_IP

MASTER_PORT

CALLSIGN

RADIO_ID

RX_FREQ

TX_FREQ

TX_POWER

COLORCODE

LATITUDE

LONGITUDE

HEIGHT

LOCATION

DESCRIPTION

SLOTS

URL

SOFTWARE_ID

PACKAGE_ID

GROUP_HANGTIME

OPTIONS

ACL Usage for Peer Instances

It's a bit redundant to consider whether rpeers should be deciding whether another peer can connect to it. If a peer is connecting to a master, the assumption is that it is appropriate that all peers connect with each other. Hence, the concept of REG_ACL is not relevant in this section and any value set with that key will be ignored.