knusperkrone

This guide is unmaintained and was created for a specific workshop in 2017. It remains as a legacy reference. Use at your own risk.

Running your own encrypted chat service with Matrix and Riot

Workshop Instructor:

Lilly Ryan @attacus_au

This workshop is distributed under a CC BY-SA 4.0 license.

What are we doing here?

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

General rules

Follow standard conventions.
Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
Boy scout rule. Leave the campground cleaner than you found it.
Always find root cause. Always look for the root cause of a problem.

Design rules

Instructions

CloudFlare is an awesome reverse cache proxy and CDN that provides DNS, free HTTPS (TLS) support, best-in-class performance settings (gzip, SDCH, HTTP/2, sane Cache-Control and E-Tag headers, etc.), minification, etc.

Make sure you have registered a domain name.
Sign up for CloudFlare and create an account for your domain.
In your domain registrar's admin panel, point the nameservers to CloudFlare's (refer to this awesome list of links for instructions for various registrars).
From the CloudFlare settings for that domain, enable HTTPS/SSL and set up a Page Rule to force HTTPS redirects. (If you want to get fancy, you can also enable automatic minification for text-based assets [HTML/CSS/JS/SVG/etc.], which is a pretty cool feature if you don't want already have a build step for minification.)
If you

	#!/bin/bash

	# Raspberry Pi ZRAM script
	# Tuned for quad core, 1 GB RAM models
	# put me in /etc/init.d/zram.sh and make me executable
	# then run "sudo update-rc.d zram.sh defaults"

	modprobe zram
	echo 3 >/sys/devices/virtual/block/zram0/max_comp_streams
	echo lz4 >/sys/devices/virtual/block/zram0/comp_algorithm