summaryrefslogtreecommitdiff
path: root/provisioning/README.md
diff options
context:
space:
mode:
authorMircea Moise <mmoise@thoughtworks.com>2014-11-19 20:31:04 +0000
committerMircea Moise <mmoise@thoughtworks.com>2014-11-19 20:31:04 +0000
commit5d6b14b54fb69c3a611cf1f03d9e8bf2d76a2cad (patch)
treeaa078297d619bfe34b7fa7681aacdb7d1372022c /provisioning/README.md
parentf202ed1c57d5a727dbcc6d10d6a669d363639ab3 (diff)
Added vagrantfile and provisioning scripts so the service can be run inside a vagrant box
Diffstat (limited to 'provisioning/README.md')
-rw-r--r--provisioning/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/provisioning/README.md b/provisioning/README.md
new file mode 100644
index 00000000..46acbf0b
--- /dev/null
+++ b/provisioning/README.md
@@ -0,0 +1,22 @@
+ Setup for developers
+=====================
+The following instructions describe how to setup a Vagrant box for development. You need to have Vagrant installed on your system.
+
+# Vagrant setup
+
+Create and provision Vagrant box
+```sh
+$ vagrant up
+```
+
+# Running the server
+Activate virtualenv and run Pixelated server
+```sh
+$ cd /vagrant/service
+$ source .virtualenv/bin/activate
+$ pixelated-user-agent --host 0.0.0.0
+```
+
+After this you will be asked to setup a LEAP provider. Once entering valid LEAP credentials, you should have the server running.
+
+You should now be able to access the web app by typing localhost:3333 on any browser running on your host machine.