w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2026-09-24 16:24:32 +00:00
Code Issues 13 Packages Projects Releases Wiki Activity

Rationalise docs part 3 #151

Browse Source
This commit is contained in:
Ian Renton
2026-09-23 17:50:04 +01:00
parent c9d0a7652c
commit 2d14342089
14 changed files with 76 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -24
View File
@@ -1,4 +1,4 @@
# ![Spothole](/static/img/logo.png)
# ![Spothole](https://git.ianrenton.com/ian/spothole/raw/branch/main/static/img/logo.png)
Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
JSON API as well as a website to browse the data, and its own telnet server for integration with desktop loggers.
@@ -17,42 +17,25 @@ individual data source presents its data.
Spothole itself is also open source, Public Domain licenced code that anyone can take and modify.
Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA,
SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, Tiles on the Air, the UK Packet
Repeater Network, NG3K, and any site based on the xOTA software by nischu. It also integrates with QRZ.com and HamQTH,
retrieves solar data from various sources, provides information about upcoming contests, and more.
You can read more about Spothole on [the "About" page of the main server instance](https://spothole.app/about).
You can read more about Spothole on [the "Help" pages of the main server instance](https://spothole.app/help).
![Screenshot](/images/screenshot2.png)
![Screenshot](/images/screenshot3.png)
## Accessing the public version
You can access the public version's web interface at [https://spothole.app](https://spothole.app), and
see [https://spothole.app/apidocs](https://spothole.app/apidocs) for the API details.
This is a Progressive Web App, so you can also "install" it to your Android or iOS device by accessing it in Chrome or
Safari respectively, and following the menu-driven process for installing PWAs.
You are more than welcome to use the data and the API that Spothole provides to power your own software, to run your own
Spothole server, or to modify it in any way. More details can be found in the following sections:
Spothole server, or to modify it in any way. More details can be found
in [the "Help" pages of the main server instance](https://spothole.app/help).
* [Embedding Spothole in another website](docs/embedding.md)
* [Writing your own client](docs/clients.md)
* [Running your own copy](docs/running.md)
* [nginx reverse proxy configuration](docs/nginx.md)
* [systemd service file](docs/systemd.md)
* [Running in Docker](docs/docker.md)
* [Use of multiple cluster logins](docs/multicluster.md)
* [Modifying the source code](docs/modifying.md)
![Screenshot](/images/screenshot4.png)
![Screenshot](/images/screenshot3.png)
## Thanks
[Spothole's "About" page](https://spothole.app/about) contains the full details of the thanks I owe to the various
[Spothole's "Thanks" page](https://spothole.app/help/thanks) contains the full details of the thanks I owe to the
various
programme teams, software library providers, bug fixers etc. The extra detail below contains the extra detail of
specific files in this repository which are not all my own work and may be subject to other licences.