From 9d52ed367f3eeea4ad9c23c61a3628418eac13e1 Mon Sep 17 00:00:00 2001
From: pierreozoux <pierre@ozoux.net>
Date: Tue, 10 Mar 2015 12:40:23 +0000
Subject: [PATCH] Readme instructions fixes #45

---
 README.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1099a4d..a09be90 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,36 @@
 
 This repository contains the configuration and scripts I use to control my servers.
 
-There is no documentation yet, work in progress. If you want to use this repo, please send me an email.
+### Tests
+
+There is a script that provision 2 VMs on Vutlr for tests purpose.
+
+#### Prerequisites
+
+ - have a [vultr account](http://www.vultr.com/?ref=6810586)
+ - have a [VULTR API KEY](https://my.vultr.com/settings/)
+ - have the [port 25 open](https://www.vultr.com/docs/what-ports-are-blocked) (if you want to test emails)
+ - have an [ssh key registered](https://my.vultr.com/sshkeys/)
+
+#### Start tests
+
+/!\ This is still in dev, use it at your own risk /!\
+
+```
+export VULTR_API_KEY=
+./script/start.sh #need root access to modify your /etc/hosts
+ssh root@server.test
+cd /data/indiehosters
+./tests/start.sh
+./tests/dovecot.sh
+reboot
+ssh root@server.test
+./tests/stop.sh
+exit
+./script/stop.sh #need root access to modify your /etc/hosts
+```
+
+Most of the tests are "visual", but by reading them, it gives you an idea on how to start and stop services.
+
+This is still work in progress, please feel free to contribute to it!
 
-- 
GitLab