puppet-pixelated

Pixelated is in an early stage of development! Things may not work to their full extent yet

This puppet module provides a simple way to add Pixelated to a running LEAP Platform. It sets up the Pixelated User-Agent.

High level Architecture

Pixelated Platform

Testing Pixelated

If you want to have a look at pixelated, the easiest way is to run everything inside vagrant. The following command installs the Pixelated User Agent and the Leap Platform at once (this may take a while, please be patient):

$ curl https://raw.githubusercontent.com/pixelated/puppet-pixelated/master/vagrant_platform.sh | sh

Once installed, you can create accounts by visiting the LEAP Webapp at localhost:4443/signup and see Pixelated in action at localhost:8080.

NOTE: Be aware that you will not be able to send mails outside, but you can test sending mails internally from one user to another.

Manual installation

1 Creating a LEAP Provider

Pixelated is built on top of LEAP, so in order to have a Pixelated Platform, you need to have a LEAP Platform.

In this example, we use a single node setup. Please refer to https://leap.se/en/docs/platform/tutorials/single-node-email for help with setting up a LEAP provider. We assume that you have the LEAP platform and the configuration for your LEAP node on your local workstation. If you followed the tutorial you should have the following directories:

~/leap/leap_plaform: the LEAP platform itself
~/leap/example: the configuration for your LEAP provider node

Ideally you have run leap deploy and leap test to set up the node on a server and verify that the installation actually works.

2 Adding Pixelated to your existing LEAP configuration

This puppet module take care of (almost) everything. It will install the pixelated-user-agent.

Please note that currently, you need proper DNS entries for your provider domain and all of its subdomains (hostname1.DOMAIN, DOMAIN, api.DOMAIN and nicknym.DOMAIN). You can access your LEAP provider with only local DNS overrides, but you cannot do this for the pixelated user agent.

Add the pixelated-platform files to files/puppet inside your LEAP configuration folder.

$ cd ~/leap/example
$ mkdir -p files/puppet/modules

The documentation for the installation of the LEAP Platform suggests that you make the configuration folder (~/leap/example is the name they suggest) versioned using Git to make it easier to track and undo any changes on the configuration. If you followed this suggestion of the tutorial, the easiest way to get the Pixelated platform is to add it as a submodule.

$ git submodule add https://github.com/pixelated/puppet-pixelated.git files/puppet/modules/pixelated

If you haven't added version control to your LEAP configuration, you can simply clone the Pixelated platform files into your node configuration.

$ git clone https://github.com/pixelated/puppet-pixelated.git files/puppet/modules/pixelated

Include the ::pixelated class in the custom class, which gets automatically applied by the leap_platform.

$ mkdir -p files/puppet/modules/custom/manifests
$ echo '{}' > services/pixelated.json
$ echo 'class custom { include ::pixelated}' > files/puppet/modules/custom/manifests/init.pp

3 Installing Pixelated on the LEAP provider node

With Pixelated added to the configuration simply re-run the LEAP deployment.

$ leap deploy
$ leap test

When this completes Pixelated should be ready and available on port 8080 on your LEAP provider.

Have fun!

Running Funcional Tests (local)

From: $ cd files/functional-tests

Install python dependencies: $ pip install -r test_requirements.txt

Install phantomjs: $ npm install phantomjs -g

Setting your host as pixelated-platform on the TESTHOST environment variable: $ export TESTHOST=<your-host-url>

And to run: $behave

To run a feature: $ behave -t @mail_to_myself

To run a set of tests: $ behave -t @staging

Development

Run tests

$ bundle install --path vendor/bundle
$ bundle exec rake test

pixelated / puppet-pixelated