5.2 KiB
Edgebox Control Module
A System Control module written in Go. Its resonsability is to configure dependencies and perform system tasks, automatically in a schedule, or by command.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
About The Project
![Edgebox Screen Shot][product-screenshot]
Edgebox is a small box that connects alongside your home internet router. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
If you're installing this to run natively in the system, you better be doing it inside of the Development Virtual Machine. This software can do destructive action in the system is is running. You've been warned.
If you're running for development purposes, a Docker container suffices, so make sure you have:
- Docker
- Docker Compose
sudo apt-get install docker docker-compose
Check the following links for more info on Docker and Docker Compose.
Aditionally, edgeboxctl needs the following bash commands available wherever it runs:
arm-linux-gnueabi-gcc(sudo apt-get install gcc-arm*)shrmsystemctllsblkyqtinc-boot(not mandatory)
Installation
- Clone the repo
git clone https://github.com/edgebox-iot/edgeboxctl.git
- Run Docker-Compose
docker-compose up
Usage
For more examples, please refer to the Documentation
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.