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
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

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

• Go Lang
• SH
• Lots of Love <3

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.

Installation

1. Clone the repo

git clone https://github.com/edgebox-iot/edgeboxctl.git

2. 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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.