diff --git a/docs/prerequisite.md b/docs/prerequisite.md new file mode 100644 index 0000000..ed37210 --- /dev/null +++ b/docs/prerequisite.md @@ -0,0 +1,26 @@ +# Prerequisites + +Basic understanding of logging in to a systems console, and root access are +both necessariy for installation + +## Docker & Docker-Compose + +The default deployment model uses Docker and Docker Compose to deploy +containers for the project's tools, and so, require the following: + +* Docker >= 1.13.1 +* Docker Compose >= 1.15.0 + +``` +$ sudo apt install docker docker-compose +$ sudo systemctl enable docker +$ sudo systemctl start docker +``` +## Quickstart Repository + +For the quickstart tutorial, you'll need to install a git client, and check out with repository: + +``` +$ sudo apt install git +$ git clone https://github.com/CommunityHoneyNetwork/chn-quickstart.git +```