Skip to content

BD5HTY/open-hamclock-backend

 
 

Repository files navigation

🛟 📡 OHB — Open HamClock Backend

When the original backend went dark, the clocks didn’t have to.

What is OHB?

OHB is an open-source, backend replacement for HamClock. It maintains the HamClock interface by dynamically generating live propagation data, maps, and feeds. It can be hosted on compute as small as a Raspberry Pi3B+.

Overview

Mitigates centralized backend risk by enabling deployment across multiple independent, federated instances. Continuity is guaranteed since OHB is open source and easily maintained.

All maps + data feeds are generated on your own compute.

Note: VOACAP DE-DX, VOACAP REL/TOA are in work.

Cost

The software is free to use and download. We do not take donations.

Feed Info

All data feeds and maps are generated on your own compute. Backend selection always remains user-controlled - no lock-in to OHB if you change your mind.

What's a "backend"?

It is how HamClock got all of its data. Without a separate backend, all HamClock's might cease to function by June 2026. Switch now or switch later, your call. There is no rush if you are not comfortable.

Important Note

This project is not affiliated with HamClock or its creator, Elwood Downey, WB0OEW. We extend our sincere condolences to the Downey family.

⚙️ What OHB Does

  • Implements a self-hosted backend compatible with the HamClock backend interface
  • Rebuilds HamClock dynamic text feeds (solar, geomag, DRAP, PSK, RBN, WSPR, Amateur Satellites, DxNews, Contests, etc) all on your own hardware
  • Generates faithful HamClock-style map overlays (MUF-RT, DRAP, Aurora, Wx-mB, etc.) Note: Maps may vary slightly due to upstream model differences
  • Produces zlib-compressed BMP assets in multiple resolutions using the same specialized, RGB top down approach that is required by HamClock
  • Designed for Raspberry Pi, cloud, or on-prem deployment
  • Fully open source and community maintained
  • Requires new, scalable PSK Reporter Fast Cache Service
  • Auto log rotation
  • Command and Control Dashboard (future)
  • Runs in Raspberry Pi 4, 5, PC, Virtual Machine, Bare Metal or Cloud

🧱 OHB Central Server (testing)

These steps let you point a HamClock (or any client) at a shared OHB test server without self-hosting. This is a local-only change on your machine and is easy to revert.

This is a test server and may be subject to unannounced or unplanned updates.

Important: Editing your hosts file overrides normal DNS for the specified hostname. After this change, anything on this computer that connects to clearskyinstitute.com will go to the OHB test server instead.

/etc/hosts file modification

These steps will tell your system to not use clearskyinstitute.com if you do not use the -b option for local install. For now, do not use this option if you are self-hosting. This is a semi-permanent change.

/etc/hosts doesn't persist after a reboot on Trixie.

It's controlled by this line in /boot/firmware/user_data

manage_etc_hosts: true

It must be set to false, and then the Pi rebooted to take into effect so that /etc/hosts will persist. Set manage_etc_hosts to false and reboot before modifying your /etc/hosts file.

sudo nano /etc/hosts

Add this line:

44.32.64.64 clearskyinstitute.com

Save the file with CTRL+X

Next, verify it is in effect

getent hosts clearskyinstitute.com

It should return

44.32.64.64 clearskyinstitute.com

Finally, you should be able to ping the re-directed host

ping -c 5 clearskyinstitute.com

It should say 100% and you should be able to restart your hamclock to connect to ohb.hamclock.app.

-b option

HamClock version 4.22 has been tested with the -b option. You can connect without modifying your /etc/hosts file. This will allow you to switch between different backends and is the easiest option for most people.

In the directory where hamclock is installed,

./hamclock -b ohb.hamclock.app:80

If unsure, you can type

which hamclock

and if hamclock is installed in your PATH on the system then it will tell you where the application is installed. From there, you can type the path to hamclock

/path/to/hamclock -b ohb.hamclock.app:80

/path/to/hamclock may vary on your system

Transitioning? Be sure to clear your .hamclock cache

For users transitioning immediately from ClearSkyInstitute or another backend server, it is important that you clear these two file types to ensure you pull latest upon connecting to either your local backend or the central backend. This involves deleting *.bmp and *.txt from your .hamclock cache directory. Do not delete the eeprom file or you will lose your settings.

rm /root/.hamclock/*.bmp /root/.hamclock/*.txt
rm /home/*/.hamclock/*.txt /home/*/.hamclock/*.bmp

🧭 Architecture

[ NOAA / KC2G / PSK / SWPC ]
              |
              v
        +-------------+
        |     OHB     |
        |-------------|
        | Python/Perl|
        | GMT/Maps   |
        | Cron Jobs  |
        +-------------+
              |
           HTTP/ZLIB
              |
         +----------+
         | lighttpd |
         +----------+
              |
         +----------+
         | HamClock |
         +----------+

Compatibility 👉 Compatibility

💬 Join us on Discord

We are building a community-powered backend to keep HamClock running.
Discord is where we can collaborate, troubleshoot, and exchange ideas — no RF license required 😎
https://discord.gg/wb8ATjVn6M

OHB in Production (Live HamClock Clients)

Automatic AMSAT Satellite Updater Backend - Keep Your Satellites Fresh!

Note: This will only list ACTIVE AMSAT satellites from the AMSAT Status Page.

image image image image image image image image image image image

🚀 Quick Start 👉 Quick Start Guide

📦 Installation 👉 Detailed installation instructions

📊 Project Completion Status

OHB targets ~40+ HamClock artifacts (feeds, maps, and endpoints).

As of today:

  • All core dynamic maps implemented
  • All text feeds replicated
  • Amateur satellites with fresh TLEs
  • RSS feed works for thousands for clients
  • Integration-tested on live HamClock clients
  • Remaining work focused on VOACAP + RBN endpoints

👉 Full artifact tracking and integration status: PROJECT_STATUS.md

📚 Data Attribution 👉 Attribution

All we ask is if you fork OHB that you clearly list what parts of OHB you re-used and what parts you changed.

🤝 Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/BrianWilkinsFL/open-hamclock-backend/issues

📄 Disclaimer 👉 Disclaimer

Related

About

Replacement Backend for HamClock

Resources

License

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 36.1%
  • Shell 35.1%
  • Perl 23.8%
  • HTML 3.3%
  • Dockerfile 1.2%
  • C++ 0.5%