Overview

This is a Spreed Signalling server jail that can be started with pot.

The jail exposes parameters that can either be set via the environment.

It also contains node_exporter and a local consul agent instance to be available that it can connect to (see configuration below). You can e.g. use the consul pot flavour on this site to run consul.

Setup

You must run this instance from a top level domain such as signal.yourdomain.com.

Installation

Create a ZFS data set on the parent system beforehand

zfs create -o mountpoint=/mnt/spreeddata zroot/spreeddata

Create your local jail from the image or the flavour files.
Clone the local jail

Mount in the ZFS data set you created

pot mount-in -p <jailname> -m /mnt -d /mnt/spreeddata

Adjust to your environment:

sudo pot set-env -p <jailname> \
 -E DATACENTER=<datacenter name> \
 -E CONSULSERVERS="<comma-deliminated list of consul servers>" \
 -E GOSSIPKEY=<32 byte Base64 key from consul keygen>] \
 -E NODENAME=<name of node> \
 -E IP=<IP address> \
 -E DOMAIN=<domain name> \
 -E EMAIL=<email address for certificate registration> \
 -E NEXTCLOUDURL=<FQDN nextcloud host, no https> \
 -E SHAREDSECRET=<shared secrt with nextcloud host> \
 [ -E REMOTELOG=<IP of syslog-ng server> ]

The DATACENTER parameter is the name of the datacenter.

The CONSULSERVERS parameter is a comma-deliminated list of IP addresses for the consul server or cluster. Do not include spaces!

e.g. CONSULSERVERS="10.0.0.2" or CONSULSERVERS="10.0.0.2,10.0.0.3,10.0.0.4,10.0.0.5,10.0.0.6"

The GOSSIPKEY parameter is the gossip encryption key for consul agent.

The NODENAME parameter is the name of the node.

The IP parameter is the IP address of this image.

The DOMAIN parameter is the domain name to use for acme.sh SSL certificate registration. It will be the same as the servername for the host.

The EMAIL parameter is the email address to use for acme.sh SSL certificate registration.

The NEXTCLOUDURL parameter is the FQDN of the Nextcloud instance. Do not include https://.

The SHAREDSECRET parameter is the shared secret with the Nextcloud instance. This must be 16 or 32 characters.

REMOTELOG is an optional parameter for a remote syslog service, such as via the loki or beast-of-argh images on potluck site.

Usage

tba

Getting Started

How To Use The Ready-Made Image

FreeBSD 14.0:
pot import -p nextcloud-spreed-signalling-amd64-14_0 -t 0.0.4 -U https://potluck.honeyguide.net/nextcloud-spreed-signalling

With Signify Verification:
fetch https://potluck.honeyguide.net/potluck.pub; pot import -p nextcloud-spreed-signalling-amd64-14_0 -t 0.0.4 -C potluck.pub -U https://potluck.honeyguide.net/nextcloud-spreed-signalling

If you don’t want to use the default pot bridged network configuration but instead need an individual network setup (e.g. assign a host IP address), after importing it you can simply clone the jail like that (em0 is the host network adapter in this example):
pot clone -P nextcloud-spreed-signalling-amd64-14_0 -p my-cloned-jail -N alias -i "em0|10.10.10.10"

Note: Some images might require specific network configuration, double check the Overview-chapter at the top.

Alternatively: Create a Jail With This Flavour Yourself

1. Create Flavour Files

Save all files and directories from https://github.com/hny-gd/potluck/tree/master/nextcloud-spreed-signalling to /usr/local/etc/pot/flavours/

2. Create Jail From Flavour

Run
pot create -b <FreeBSD Version> -p <jailname> -t single -N public-bridge -f fbsd-update

with your FreeBSD version (e.g. 14.0) and the name your jail should get.