diff --git a/README.md b/README.md index 69d493e..4fe022d 100644 --- a/README.md +++ b/README.md @@ -15,26 +15,71 @@ Currently the following providers status pages are supported: If you are missing a status page feel free to add it to `conf/feeds.json` and to create a PR! -## Todos +### Todos - Backend - Date normalization - Strip bad encodings - Option to query only some providers -## Setup +## Installation Script -Install backend dependencies: +Download the script https://raw.githubusercontent.com/lwindolf/multi-status/install_multi-status.sh + +Make the script executable + + chmod +x /install_multi-status.sh + +Run the script from your download location + + sudo /install_multi-status.sh + +...OR... + +## Manual Setup + +Choose a location to clone the repo into + + cd + git clone https://github.com/lwindolf/multi-status.git + +### Install backend dependencies sudo apt-get install libjson-perl libxml-feed-perl -Run backend updater +### Run backend updater - ./backend/update.pl > ./frontend/data.json + cd /backend + ./update.pl > /frontend/data.json + -Serve frontend for testing with +### Serve frontend for testing with ln -s frontend multi-status python3 -m http.server and access `http://localhost:8000/multi-status` + +### Running multi-status as a service (make sure you modify the --directory path here) + + cat </multi-status + WorkingDirectory=/multi-status + Restart=always + RestartSec=3 + + [Install] + WantedBy=multi-user.target + EOF + + #### Reload systemd + sudo systemctl daemon-reload + + #### Start and enable the service + sudo systemctl start multi-status + sudo systemctl enable multi-status