2021-06-10 13:02:41 +00:00
|
|
|
# Snikket server images
|
2020-01-31 13:46:46 +00:00
|
|
|
|
|
|
|
|
This is the source repository for building [Snikket service](https://snikket.org/service/)
|
|
|
|
|
Docker images.
|
|
|
|
|
|
2021-06-10 13:02:41 +00:00
|
|
|
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](https://snikket.org/).
|
|
|
|
|
|
|
|
|
|
## Getting Started with Snikket
|
|
|
|
|
|
|
|
|
|
For instructions on getting started with Snikket, see the [Snikket installation
|
|
|
|
|
guide](https://snikket.org/service/quickstart/) 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
|
2020-01-31 13:46:46 +00:00
|
|
|
|
|
|
|
|
- GNU make
|
|
|
|
|
- docker (tested on 19.03.5)
|
|
|
|
|
- ansible (tested on 2.7 (debian buster))
|
|
|
|
|
|
2021-06-10 13:02:41 +00:00
|
|
|
### Building
|
2020-01-31 13:46:46 +00:00
|
|
|
|
2020-01-31 14:07:21 +00:00
|
|
|
Run `make`
|
2020-01-31 13:46:46 +00:00
|
|
|
|
2021-06-10 13:02:41 +00:00
|
|
|
### Running
|
2020-01-31 13:46:46 +00:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2020-01-31 14:07:21 +00:00
|
|
|
```console
|
|
|
|
|
docker-compose up -d
|
|
|
|
|
```
|
