|
||
---|---|---|
.github | ||
.vscode | ||
cmd/edgeboxctl | ||
docs/img | ||
internal | ||
scripts | ||
.gitignore | ||
CHANGELOG.md | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
codecov.yml | ||
docker-compose.yml | ||
edgeboxctl.service | ||
go.mod | ||
go.sum |
README.md
Edgebox Control Module
A System Control module written in Go. Its responsibility is to configure dependencies and perform system tasks, automatically on a schedule, or on demand.
Report Bug
·
Request Feature
Table of Contents
About The Project
Edgebox is an easy to configure and use system. 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 running for development purposes, a docker container suffices, so make sure you have:
- docker
- docker compose (docker-compose-v2 package)
Check the following links for more info on Docker and Docker Compose.
Note: If you don't have docker compose
available, install it with: sudo apt-get install docker-compose-v2
Aditionally, edgeboxctl
needs the following bash commands available wherever it runs:
arm-linux-gnueabi-gcc
(sudo apt-get install gcc-arm*
)sh
rm
systemctl
lsblk
yq
tinc-boot
(not mandatory)
Installation
- Clone the repo
git clone https://github.com/edgebox-iot/edgeboxctl.git
- Run Docker Compose
docker compose up
<!-- USAGE EXAMPLES -->
## Usage
_For more examples, please refer to the [Documentation](https://github.com/edgebox-iot/docs/)_
<!-- ROADMAP -->
## Roadmap
See the [open issues](https://github.com/edgebox-iot/edgeboxctl/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## 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 -->
## License
Distributed under the Elastic License 2.0. See `LICENSE` for more information.