Sense of community is a deployment of a tool set for private parties. The goal is to provide a toolchain to manage guests as well as helpers seamlessly. The main application used for this purpose is pretix.

Pretix and other services are provided via traefik as reverse-proxy. We recommend to use an external smtp server for sending emails. The configuration of a self-hosted e-mail service is not that easy.

Requirements

This list is not complete. Please check the documentation of the tools for further information.

• docker
• docker-compose
• git
• Optional: openssl only for random password generation

Get started

1. Clone this repository and create a docker network:

git clone git@github.com:ABartelt/sense-of-community.git /opt/sense-of-community
cd /opt/sense-of-community
sudo docker swarm init
sudo docker network create --driver=overlay proxy

2. Optional Create a copie of the .env.example file and prefill some generated passwords:

# Create .env file if it doesn't exist and fill it with some random passwords
if [ ! -f .env ]; then
    cp .env.example .env
    # Parse each entry of .env.example and generate a password for it
    value=$(openssl rand -base64 6)
    sed -i '' "s/POSTGRES_ADMIN_PASSWORD=/POSTGRES_ADMIN_PASSWORD=$value/g" .env
    value=$(openssl rand -base64 6)
    sed -i '' "s/PRETIX_POSTGRES_PASSWORD=/PRETIX_POSTGRES_PASSWORD=$value/g" .env
    value=$(openssl rand -base64 6)
    sed -i '' "s/PRETIX_POSTGRES_USER=/PRETIX_POSTGRES_USER=$value/g" .env
fi

3. Replacing the variables of your .env in all config files. See Configuration for more information.

sudo ./replace.sh

4. Start the stack:

sudo chown -R 15371:15371 /opt/sense-of-community/pretix/etc/
sudo chmod 0700 /opt/sense-of-community/pretix/etc/pretix.cfg
docker stack deploy -c /opt/sense-of-community/traefik/docker-compose.yml traefik
docker stack deploy -c /opt/sense-of-community/pretix/docker-compose.yml pretix

Services provided in this deployment

There are a couple of docker-compose files which contains the full softwarestack. They contain:

• postgres as database
• postgres-backup as backup tool via `pg_dump
• redis as cache and message broker
• traefik as reverse-proxy
• pretix as the main tool for guest management.

Configuration

Variables and secrets that could be replaced in .env Everything else should be configured in the pretix.cfg file. You find the full configuration options for pretix here.

Section	Key	Default Value	Description
Traefik	TRAEFIK_DASHBOARD_HOSTNAME	traefik.local	The traefik dashboard is provided under this hostname.
	TRAEFIK_LETS_ENCRYPT_EMAIL	your-email@tld.org	This is needed by letsencrypt to issue TLS certificates. This is mandatory for cert issuing
Pretix	PRETIX_HOSTNAME	https://pretix.example.com
	PRETIX_INSTANCE_NAME	My Pretix instance	Name your instance, e.g. "My organizer name"
Pretix database	POSTGRES_ADMIN_PASSWORD	Will be generated
	PRETIX_POSTGRES_PASSWORD	Will be generated
	PRETIX_POSTGRES_USER	Will be generated
	PRETIX_POSTGRES_DB	pretix
Pretix Mail	PRETIX_MAIL_HOST	You have to set this	Here the smtp hostname is required. Like smtp.gmail.com
	PRETIX_MAIL_USER	You have to set this	The smtp user which could login at the smtp hostname. Most commonly its an e-mail address.
	PRETIX_MAIL_PASSWORD	You have to set this	The credential for the username above if the server needs an authentication. Most do.
	PRETIX_MAIL_PORT	You have to set this	Common ports for encrypted smtp connection are 587 or 465. In some cases 25. Look it up at your mail provider.
	PRETIX_MAIL_FROM	You have to set this	E-Mail adresse which should be displayed if pretix sends mails.