diff --git a/README.md b/README.md index 375e1d6..3a56daa 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -wand +# wand + +Wand makes it easy to configure dash, houdini and a media server. + +## Basic setup + +**Step 1** Install git, docker & docker-compose + +```bash +$ sudo apt-get update +$ sudo apt-get install apt-transport-https ca-certificates curl software-properties-common +$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add – +$ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" +$ sudo apt install git docker-ce +$ sudo curl -L "https://github.com/docker/compose/releases/download/1.25.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose +$ sudo chmod +x /usr/local/bin/docker-compose +``` + +**Step 2** Clone the repository +```bash +$ git clone https://github.com/solero/wand && cd wand +``` + +**Step 3** Edit the config file +```bash +$ nano .env +``` + +**Step 4** Start the services +```bash +$ sudo docker-compose up +``` + +**Step 5** You're done! \ No newline at end of file