summaryrefslogtreecommitdiff
path: root/docs/platform/tutorials/quick-start.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/platform/tutorials/quick-start.md')
-rw-r--r--docs/platform/tutorials/quick-start.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/platform/tutorials/quick-start.md b/docs/platform/tutorials/quick-start.md
new file mode 100644
index 0000000..9051f03
--- /dev/null
+++ b/docs/platform/tutorials/quick-start.md
@@ -0,0 +1,75 @@
+@title = 'LEAP Platform quick start tutorial'
+@nav_title = 'Quick Start'
+@summary = 'Getting leap platform up, the quick way'
+
+
+Testing Leap platform with Vagrant
+==================================
+
+There are two ways how you can setup leap platform
+using vagrant.
+
+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 how
+to setup a single node mail server.
+
+
+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.
+
+Start the vagrant box with
+
+ 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`
+
+
+Using the bitmask client
+========================
+
+Download the provider ca:
+
+ wget --no-check-certificate https://example.org/ca.crt -O /tmp/ca.crt
+
+Start bitmask:
+
+ bitmask --ca-cert-file /tmp/ca.crt
+
+
+
+Recieving Mail
+--------------
+
+Use i.e. swaks to send a testmail
+
+ swaks -f noone@example.org -t testuser@example.org -s example.org
+
+and use
+
+ offlineimap -c vagrant/.offlineimaprc.example.org
+
+to fetch it.
+WARNING: Use offlineimap *only* for testing/debugging,
+because it will save the mails *decrypted* locally to
+your disk !
+