w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2025-10-27 08:49:27 +00:00
Code Issues 11 Packages Projects Releases Wiki Activity

README and main filename change

Browse Source
This commit is contained in:
Ian Renton
2025-10-03 14:31:05 +01:00
parent 7afedf2315
commit df43bd918b
3 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -20,10 +20,31 @@ TODO
### Running your own copy
TODO
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.
Then, 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.
### Writing your own client
TODO