Go to file
Matthew Wild 57f4310b2d Github: Calculate correct image tag to push 2020-05-13 16:21:30 +01:00
.github/workflows Github: Calculate correct image tag to push 2020-05-13 16:21:30 +01:00
ansible prosody: Fix incorrect JID of general group 2020-05-13 14:26:58 +01:00
docker docker: Switch default BUILD_SERIES to dev 2020-05-13 13:57:22 +01:00
snikket-modules Initial commit 2020-01-31 13:46:46 +00:00
tools Initial commit 2020-01-31 13:46:46 +00:00
www Initial commit 2020-01-31 13:46:46 +00:00
.hg_archival.txt Initial commit 2020-01-31 13:46:46 +00:00
.hgignore Initial commit 2020-01-31 13:46:46 +00:00
CHANGELOG.md CHANGELOG fixes 2020-05-13 14:38:50 +01:00
LICENSE Clarify licensing as Apache 2.0 2020-02-17 17:29:25 +00:00
Makefile Initial commit 2020-01-31 13:46:46 +00:00
NOTICE Clarify licensing as Apache 2.0 2020-02-17 17:29:25 +00:00
README.md Markup fixes for README.md 2020-01-31 15:07:21 +01:00
docker-compose.yml docker-compose, prosody: Switch to host networking for the container 2020-05-12 15:05:42 +01:00
snikket.conf.example Initial commit 2020-01-31 13:46:46 +00:00

README.md

Snikket builder

This is the source repository for building Snikket service Docker images.

Requirements

  • GNU make
  • docker (tested on 19.03.5)
  • ansible (tested on 2.7 (debian buster))

Building

Run make

Running

The easiest way is to use docker-compose. Copy the file snikket.conf.example to snikket.conf and edit the values in it. Then run:

docker-compose up -d

If you need to change port mappings or any other advanced options, you can edit the docker-compse.yml file.

Alternatively you can run docker manually with something like the following:

docker run --env-file=snikket.conf -p 80:5280 -p 443:5281 -p 5222:5222 -p 5269:5269 snikket

Development

Dev images have a few additional features.

Local mail server

Outgoing emails from dev images are captured by a local MailHog instance and are accessible in a dashboard served on port 8025. The dashboard requires authentication. The username is 'snikket' and the auto-generated password can be found with the following command:

docker exec snikket_snikket_1 cat /tmp/mailhog-password

Replace snikket_snikket_1 with the name of your running container if it differs.

MailHog is not included in production images, which require a real SMTP server.