diff options
| author | xengineering <mail2xengineering@protonmail.com> | 2020-09-17 13:45:23 +0200 |
|---|---|---|
| committer | xengineering <mail2xengineering@protonmail.com> | 2020-09-17 13:47:14 +0200 |
| commit | 9f56d553235369f60c68c07f473d89492f04e27c (patch) | |
| tree | 2984845bc7cf3d71f207546060a4dde4728c0b5a /README.md | |
| parent | 098a236d1dfe26be3ec1653fba28703e964f7e62 (diff) | |
| download | picontrol-9f56d553235369f60c68c07f473d89492f04e27c.tar picontrol-9f56d553235369f60c68c07f473d89492f04e27c.tar.zst picontrol-9f56d553235369f60c68c07f473d89492f04e27c.zip | |
Improve Documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 15 insertions, 6 deletions
@@ -5,17 +5,25 @@ A small Web Application to shutdown or reboot your Raspberry Pi. -## Current State - -The code works but there is still documentation / automation missing. +## Usage +### Preparation -## Usage +Make sure to open your firewall on port 8080. **If** you use UFW you can do it like this: +```bash + sudo ufw allow 8080 +``` -**Please cd into the repository to install/uninstall!** +Install python3, Flask and waitress. python3 installation depends on your system. +With pip you can install Flask and waitress very easily: +```bash + sudo pip3 install Flask waitress +``` ### How to install, start and enable ```bash + git clone https://github.com/xengineering/picontrol.git + cd picontrol sudo useradd -rUs /usr/bin/nologin picontrol sudo make install sudo systemctl enable --now picontrol @@ -24,5 +32,6 @@ The code works but there is still documentation / automation missing. ### How to remove ```bash sudo systemctl disable --now picontrol - sudo make uninstall + sudo make uninstall # just works from picontrol directory (the git repository you cloned) + sudo userdel picontrol ``` |