summaryrefslogtreecommitdiff
path: root/pages/docs/platform
diff options
context:
space:
mode:
authorvarac <varacanero@zeromail.org>2015-12-27 19:47:28 +0100
committervarac <varacanero@zeromail.org>2015-12-27 19:51:28 +0100
commit8533f28ca9875cce016c7304e27d0c53a4edb69b (patch)
treecdd32e5f35a38150db2797c9bce40d3cfc3bcb16 /pages/docs/platform
parentcd116d3a1612b7c3f6d2d4c2aa0bb1fe60f8a78c (diff)
Updated vagrant documentation
Diffstat (limited to 'pages/docs/platform')
-rw-r--r--pages/docs/platform/troubleshooting/vagrant.md45
-rw-r--r--pages/docs/platform/tutorials/vagrant.md108
2 files changed, 108 insertions, 45 deletions
diff --git a/pages/docs/platform/troubleshooting/vagrant.md b/pages/docs/platform/troubleshooting/vagrant.md
deleted file mode 100644
index ad28416..0000000
--- a/pages/docs/platform/troubleshooting/vagrant.md
+++ /dev/null
@@ -1,45 +0,0 @@
-@title = 'LEAP Platform Vagrant testing'
-@nav_title = 'Vagrant Integration'
-@summary = 'Testing your provider with Vagrant'
-
-Setting up Vagrant for a testing the platform
-=============================================
-
-There are two ways you can setup leap platform using vagrant.
-
-Using the Vagrantfile provided by Leap Platform
------------------------------------------------
-
-This is by far the easiest way. It will install a single node mail server in the default
-configuration with one single command.
-
-Clone the platform with
-
- git clone https://github.com/leapcode/leap_platform.git
-
-Start the vagrant box with
-
- cd leap_platform
- vagrant up
-
-Follow the instructions how to configure your `/etc/hosts`
-in order to use the provider!
-
-You can login via ssh with the systemuser `vagrant` and the same password.
-
-There are 2 users preconfigured:
-
-. `testuser` with pw `hallo123`
-. `testadmin` with pw `hallo123`
-
-
-Use the leap_cli vagrant integration
-------------------------------------
-
-Install leap_cli and leap_platform on your host, configure a provider from scratch and use the `leap local` commands to manage your vagrant node(s).
-
-See https://leap.se/en/docs/platform/development how to use the leap_cli vagrant
-integration and https://leap.se/en/docs/platform/tutorials/single-node-email how
-to setup a single node mail server.
-
-
diff --git a/pages/docs/platform/tutorials/vagrant.md b/pages/docs/platform/tutorials/vagrant.md
new file mode 100644
index 0000000..c76cd84
--- /dev/null
+++ b/pages/docs/platform/tutorials/vagrant.md
@@ -0,0 +1,108 @@
+@title = 'LEAP Platform Vagrant'
+@nav_title = 'Vagrant'
+@summary = 'Running a local provider with Vagrant'
+
+Use Vagrant to install the LEAP platform
+========================================
+
+There are two ways you can setup leap platform using vagrant.
+
+Using the Vagrantfile provided by Leap Platform
+-----------------------------------------------
+
+This is by far the easiest way. It will install a single node mail server in the default
+configuration with one single command.
+We assume that you have [Vagrant](https://www.vagrantup.com/) installed and working for you.
+
+Clone the platform with
+
+ git clone --recursive -b develop https://github.com/leapcode/leap_platform.git
+
+Start the vagrant box with
+
+ cd leap_platform
+ vagrant up
+
+Follow the instructions how to configure your `/etc/hosts`
+in order to use the provider!
+
+You can login via ssh with the systemuser `vagrant` and the same password.
+
+ vagrant ssh
+
+On the host, run the tests to check if everything is working as expected:
+
+ cd /home/vagrant/leap/configuration/
+ leap test
+
+Use the bitmask client to do an initial soledad sync
+====================================================
+
+Copy the self-signed CA certificate from the host.
+The easiest way is to use the [vagrant-scp plugin](https://github.com/invernizzi/vagrant-scp):
+
+ vagrant scp :/home/vagrant/leap/configuration/files/ca/ca.crt /tmp/example.org.ca.crt
+
+ vagrant@node1:~/leap/configuration$ cat files/ca/ca.crt
+
+and write it into a file, needed by the bitmask client:
+
+ bitmask --ca-cert-file /tmp/example.org.ca.crt
+
+On the first run, bitmask is creating a gpg keypair. This is
+needed for delivering and encrypting incoming mails.
+
+
+Testing email
+-------------
+
+ sudo apt install swaks
+ swaks -f test22@leap.se -t test22@example.org -s example.org
+
+check the logs:
+
+ sudo less /var/log/mail.log
+ sudo less /var/log/leap/mx.log
+
+if an error occurs, see if the mail is still laying in the mailspool dir:
+
+ sudo ls /var/mail/leap-mx/Maildir/new
+
+
+Re-run bitmask client to sync your mail
+---------------------------------------
+
+
+ bitmask --ca-cert-file /tmp/example.org.ca.crt
+
+Now, connect your favorite mail client to the imap and smtp proxy
+started by the bitmask client:
+
+ https://bitmask.net/en/help/email
+
+Happy testing !
+
+
+
+Using the Webapp
+----------------
+
+There are 2 users preconfigured:
+
+. `testuser` with pw `hallo123`
+. `testadmin` with pw `hallo123`
+
+login as `testadmin` to access the webapp with admin priviledges.
+
+
+
+Use the leap_cli vagrant integration
+------------------------------------
+
+Install leap_cli and leap_platform on your host, configure a provider from scratch and use the `leap local` commands to manage your vagrant node(s).
+
+See https://leap.se/en/docs/platform/development how to use the leap_cli vagrant
+integration and https://leap.se/en/docs/platform/tutorials/single-node-email how
+to setup a single node mail server.
+
+