This is a fork of Cameron Gray's Home-Automation-Hub, which (hopefully) i will be keeping up-to-date.
- Ubuntu 18.04 or above
- Docker installed, docs are here
- Baisc Knowledge of: Docker, Linux and Python
Commands may differ between machines, im using Ubuntu Server 18.04 LTS.
First we need to download the files and go into the directory
git clone https://github.com/levidavis/py-home.git
cd py-home/
Now we need to use the 'Make' command to make our docker image, you dont have to run it as root but personally i needed to to allowed docker commands
sudo make
once the docker image is made we run the docker multi-container in what i like to call "Test Mode" it basically shows us a log of what is happening just in case there is any problems
sudo docker-compose up
if there is no problem running the docker then we can go and close it using Ctrl + C
Ctrl + C
now we need to get the docker containter running in the background using this command:
sudo dokcer-compose up -d
lets visit the hub now!
Goto: http://{IP ADDRESS}:8080/
Done! , What's next? i would suggest looking at the Modules Section
Commands may differ between machines, im using Ubuntu Server 18.04 LTS.
First we need to download the files and go into the directory
git clone https://github.com/levidavis/py-home.git
cd py-home/
Now lets customize!
All we need to do is change the docker-compose file!
nano docker-compose.yml
and go down line 20 and edit this (Default port is 8080):
-{PORT YOU WANT}:80
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc