snikket-server/README.md
Kim Alvefur 8c04dda2e0 docs: Update to use docker compose instead of docker-compose
Seems people have a recent enough Docker to have the new command, so
mention of the old docker-compose v1 only casues confusion.
2024-08-10 14:07:11 +02:00

1.0 KiB

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