mirror of
https://git.ianrenton.com/ian/spothole.git
synced 2026-08-08 19:41:41 +00:00
53 lines
2.6 KiB
Markdown
53 lines
2.6 KiB
Markdown
## Running your own copy
|
|
|
|
If you want to run a copy of Spothole with different configuration settings than the main instance, you can download it
|
|
and run it on your own local machine or server.
|
|
|
|
You will require Python version 3.8 or later. If you encounter an error about `gdal-config` during the following
|
|
process, you will also need `libgdal-dev` installed.
|
|
|
|
To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be
|
|
similar.
|
|
|
|
```bash
|
|
git clone ssh://git@git.ianrenton.com/ian/spothole.git
|
|
cd spothole
|
|
python3 -m venv ./.venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
deactivate
|
|
cp config-example.yml config.yml
|
|
```
|
|
|
|
Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve
|
|
enabling or disabling the various providers of spot and alert data.
|
|
|
|
By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN
|
|
spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet
|
|
spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it,
|
|
but all can be easily re-enabled.
|
|
|
|
Other parameters you will want to update include the base URL to your instance, and whether you want to serve a full
|
|
web-based DX cluster interface or just the API endpoints for client software to use.
|
|
|
|
`config.yml` has an entry for a Clublog API key. If provided, this will allow Spothole to retrieve some more information
|
|
about DX spots. The software will work just fine without it, but you may find a few country flags etc. are less accurate
|
|
or missing. Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining
|
|
what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you
|
|
change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your
|
|
server too.
|
|
|
|
Once you're happy with the content of `config.yml`, you can proceed to running the software.
|
|
|
|
To run the software this time and any future times you want to run it directly from the command line:
|
|
|
|
```bash
|
|
source .venv/bin/activate
|
|
python3 spothole.py
|
|
```
|
|
|
|
The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to
|
|
countries. This is normal, don't panic!
|
|
|
|
If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server
|
|
that is already in use by something else. |