Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Latest commit

 

History

History
64 lines (54 loc) · 2.82 KB

README.md

File metadata and controls

64 lines (54 loc) · 2.82 KB
Raw

EDDP-API

Caching server for use with EDDI and EDDN.

Dependencies

  1. Go, aka Golang.
  2. sqlite3.
  3. ZeroMQ.
  • On macOS, brew install zmq.
  • On Debian apt-get install libzmq3-dev
  1. ./getDependencies will get any Go dependencies.

Configuration

Environment variable Default value Meaning
EDDP_API_DATA_DIR ./data Directory for downloaded data and SQL database
EDDP_API_HTTP_ADDR ":8080" TCP address for the HTTP server
EDDP_API_HTTP_ROOT "./data/http" Static file root directory for the HTTP server
EDDP_API_EDDN_LISTENER_URL "tcp://eddn.edcd.io:9500" URL for the EDDN listener
EDDP_API_EDDN_PUBLISHER_URL "tcp://*:5556" URL for the EDDN publisher

Setup and development

  • ./getDependencies to get all required Go packages.
  • ./formatAll to format all Go source according to standards (Go is rather prescriptive about that).
  • ./buildAll to build all Go source.
    • Currently each build product must be manually added to .gitignore.

Usage

  • refreshEDDB to fetch the latest data from EDDB to ${dataDir}/eddb. At the time of writing this totals about 3.5GB). This script calls ...
  • rebuild to import this fetched data into SQLite. On a 2011 MacBook Air this can take around 12 min and the resulting SQLlite file is around 8.5GB. Once it completes, you need to
    • manually stop the servers systemctl stop eddpd; systemctl stop eddnlistener.
    • replace ${dataDir}/sqlite/eddp.sqlite with ${dataDir}/sqlite/eddp-new.sqlite
    • restart the servers systemctl start eddpd; systemctl start eddnlistener.
    • The raw data in ${dataDir}/eddb can then be zipped or discarded.

Server Deployment

  • Review the files systemd_configs/eddpd.service.txt and systemd_configs/eddnlistener.service.txt. These assume an installation path of /var/go/EDDP-API, so change that if necessary.
  • If you want to set any environment variables for the processes, put them in eddpd.env and eddnlistener.env, one per line, in the form NAME=value.
  • Copy eddpd.service.txt and eddnlistener.service.txt without the .txt suffix to /etc/systemd/system/ (the .txt suffix is only there to stop macOS from misinterpreting the file type).
cd systemd_configs
cp eddpd.service.txt /etc/systemd/system/eddpd.service
cp eddnlistener.service.txt /etc/systemd/system/eddnlistener.service
cd ..
  • Start the services:
systemctl start eddpd
systemctl start eddnlistener
  • Check that it is ok:
systemctl status eddpd
systemctl status eddnlistener
  • Enable automatic startup:
systemctl enable eddpd
systemctl enable eddnlistener