krstnschwpwr / speedcontrol

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Speed CTRL - Description

This application is designed to inform people about the load of their internet connection at home in form of various data visualizations in a local network. This allows the user to monitor his DSL bandwidth and offers an interface for using the PRTG software.

ToDo

  • Add development documentation
  • Improve performance
  • Enable app to run as different user
  • Better caddy installation

Installation

IMPORTANT NOTICE: All commands need to be executed as root (also the application). Currently it is not possible run the app as a different user but it is the next step on my roadmap.

curl https://gist.githubusercontent.com/krstnschwpwr/0c46c9cd4264d9b06a19552bfe257bd9/raw/1cb2bca27d218900f0ec83e87859d3b2b37babe8/setup.sh | bash
  1. Clone the git repository && setup required directories
$ cd /usr/local/
$ mkdir venvs
$ git clone https://github.com/krstnschwpwr/speedcontrol.git
$ cd speedcontrol
  1. Install requirements & Caddy
$ apt install python3 python-pip python-dev sqlite3 ufw
$ pip install virtualenv
$ virtualenv /usr/local/venvs/speedcontrol -p "$(which python3)"
$ source /usr/local/venvs/speedcontrol/bin/activate
$ pip install -r /usr/local/speedcontrol/requirements.txt
$ curl https://getcaddy.com | bash
  1. Setup system service & configure system
$ cp /usr/local/speedcontrol/speedcontrol /etc/init.d/speedcontrol
$ chmod +x /etc/init.d/speedcontrol
$ systemctl daemon-reload
$ ufw enable && ufw allow ssh && ufw allow http
  1. DONE!!! Start the service via service speedcontrol start
$ service speedcontrol [start|stop|restart]

Important files

  • Configuration files: /usr/local/speedcontrol/speed_ctrl/settings.py
  • Log files: /var/log/speedcontrol/{background|web}.log
  • PID files: /var/run/speedcontrol-{web|background}.pid

License

See the included LICENSE.

Contribution Guidelines

TBC

Development

TBC

About

License:MIT License


Languages

Language:Python 71.6%Language:HTML 19.1%Language:Shell 9.3%