Go to file
Matthew Wild c32e9c4d26
Merge branch 'master' into fix_apt_cruft2
2021-07-31 14:27:28 +01:00
.github Add FUNDING.yml 2021-06-14 11:57:03 +01:00
ansible Allow to load the prometheus exposition module based on env vars 2021-05-27 18:08:26 +02:00
docker Dockerfile: Move to top-level for consistency with our other projects 2021-05-28 14:26:56 +01:00
docs Update reverse_proxy.md 2021-07-19 13:32:25 +01:00
snikket-modules Dockerfile, mod_update_check: Update version string format 2021-05-31 12:23:52 +01:00
tools 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 Update CHANGELOG with new version number 2021-05-19 16:10:11 +01:00
Dockerfile Merge branch 'master' into fix_apt_cruft2 2021-07-31 14:27:28 +01:00
LICENSE Clarify licensing as Apache 2.0 2020-02-17 17:29:25 +00:00
Makefile Dockerfile: Move to top-level for consistency with our other projects 2021-05-28 14:26:56 +01:00
NOTICE Clarify licensing as Apache 2.0 2020-02-17 17:29:25 +00:00
README.md Update README to be more friendly for people first discovering the project 2021-06-10 14:02:41 +01:00
docker-compose.yml docker-compose.yml: Update to new image name for snikket-server 2021-02-02 14:07:51 +00:00
mkdocs.yml docs: Add initial documentation 2020-05-18 11:35:37 +01:00
po4a.conf Commit initial po4a config for docs translation (workflow still needs work) 2020-11-10 13:57:22 +00:00
snikket.conf.example Initial commit 2020-01-31 13:46:46 +00:00

README.md

Snikket server images

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

Snikket is an open-source self-hosted personal messaging service. It aims to provide an alternative to proprietary and centralized messaging platforms while supporting all the expected features and being easy to use.

For more information see the Snikket website.

Getting Started with Snikket

For instructions on getting started with Snikket, see the Snikket installation guide on our website.

Building images

This section is for people who want to build their own images of Snikket, e.g. for development purposes.

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