Skip to content

Commit

Permalink
README: Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aslmx authored Aug 19, 2021
1 parent 7d68b1b commit a6001ae
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,32 @@ Checks the official JSON files every once in a while (configurable in the config
file) for changes and sends new warnings to registered users based on the
coordinates the entered.

## Install

(tested on Linux Mint 20.2)

1. Install dependencies

sudo apt install libsqlite3-mod-spatialite

2. Install nina_xmpp

pip3 install git+https://github.com/jplitza/nina_xmpp.git

Alternatively with user only privileges:

pip3 install --user git+https://github.com/jplitza/nina_xmpp.git

3. Configure config.yml

wget https://raw.githubusercontent.com/jplitza/nina_xmpp/master/config.sample.yml -O config.yml

Open config.yml in your favourite text editor and adapt to your needs, i.e. provide XMPP credentials and admin contact

4. Run

nina_xmpp config.yml`

## Usage

Chat with the JID specified in the config to register yourself for warnings:
Expand Down

0 comments on commit a6001ae

Please sign in to comment.