summaryrefslogtreecommitdiff
path: root/docs/platform/tutorials/quick-start.md
blob: 0c6ec20c60050fadbb1fe17f11569485ea925cc1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
@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`

Testing your provider
=====================

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 your favorite mail client to examine your inbox.
You can also use [offlineimap](http://offlineimap.org/) to fetch mails: 

     offlineimap -c vagrant/.offlineimaprc.example.org

WARNING: Use offlineimap *only* for testing/debugging, 
because it will save the mails *decrypted* locally to 
your disk !