Skip to content

Commit 3d3ce3e

Browse files
author
sgofferj
committed
Update Readme, remove debug logging
1 parent 84d2fc4 commit 3d3ce3e

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[![Build and publish the container image](https://github.com/sgofferj/tak-feeder-gdacs/actions/workflows/actions.yml/badge.svg)](https://github.com/sgofferj/tak-feeder-gdacs/actions/workflows/actions.yml)
22

3-
<font color="red">**ALPHA - NOT READY FOR PRODUCTION**</font>
43
# tak-feeder-gdacs
54
Feed current GDACS disaster data into your TAK server
65

@@ -9,10 +8,17 @@ Feed current GDACS disaster data into your TAK server
98
Licensed under the GNU General Public License V3 or later.
109

1110
## Description
12-
ToDo
11+
### What is GDACS?
12+
GDACS or Global Disaster Alert and Coordination System (https://www.gdacs.org) is a cooperation framework between the United Nations and the European Commission. It includes disaster managers and disaster information systems worldwide and aims at filling the information and coordination gaps in the first phase after major disasters.
1313

14-
## Purpose
15-
ToDo
14+
GDACS provides real-time access to web‐based disaster information systems and related coordination tools.
15+
A more detailed description of GDACS purpose, content and guidelines, agreed and approved by the steering committee can be found [here](https://www.gdacs.org/Documents/GDACS%20Guidelines%202014_-_FINAL.PDF).
16+
17+
18+
### TAK server feeder
19+
This feeder pulls the RSS feeds from GDACS, converts the current events to CoT messages and sends them to a TAK server. ATAK, WinTAK and WebTAK will show the events with icons corresponding to the type of event and the severity (WinTAK doesn't show the color, though).
20+
21+
**Please note that neither the author nor this software project are in any way affiliated with GDACS.**
1622
## Configuration
1723
The following values are supported and can be provided either as environment variables or through an .env-file.
1824

@@ -25,10 +31,12 @@ The following values are supported and can be provided either as environment var
2531
| LOGCOT | false | (optional) Log created CoTs to the console |
2632
| UUID | empty | (optional) Set feeder UID - if not set, the feeder will create one |
2733

34+
Note: At the moment, only SSL TCP connections are supported.
2835
## Certificates
2936
These are the server-issued certificate and key files. Before using, the password needs to be removed from the key file with `openssl rsa -in cert.key -out cert-nopw.key`. OpenSSL will ask for the key password which usually is "atakatak".
3037

3138
## Container use
39+
First, get your certificate and key and copy them to a suitable folder which needs to be added as a volume to the container.
3240
### Image
3341
The image is built for AMD64 and ARM64 and pushed to ghcr.io: *ghcr.io/sgofferj/tag-feeder-gdacs:latest*
3442
### Docker

index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const run = () => {
5656

5757
function heartbeat() {
5858
client.write(functions.heartbeatcot(heartbeatIntervall));
59-
if (true) {
59+
if (logCot) {
6060
console.log(functions.heartbeatcot(intervalSecs));
6161
console.log('-----')
6262
}

0 commit comments

Comments
 (0)