Appimage for the Prosody XMPP server.
This package provides an AppImage for the Prosody XMPP server, so that the server can be run anywhere.
The AppImage is built using appimage-builder, and based on Debian packages to properly handle dependencies.
This repository provides appimages for following CPU architectures:
- x86_64
- ARM64
If you need another architecture, feel free to ask for by creating an issue.
This project was created for the Peertube livechat plugin, a chatting plugin for Peertube.
Prosody comes with the prosodyctl
command line tool, that allows to control Prosody.
To avoid building two appimages (one for the server, one for prosodyctl), the generated AppImage contains a wrapper:
when calling the binary, the first argument has to be prosody
or prododyctl
, depending on which you want to run.
Other parameters will be passed unchanged to prosody
or prosodyctl
.
Important note: by default, the AppImage will try to read configuration files et the AppImage itself, and this won't work.
You have always to provide a prosody.cfg.lua
file, using the --config
option. See the Prosody documentation,
or the sample file in the samples folder.
Some examples:
# launch the server:
prosody-x86_64.AppImage prosody --config sample/prosody.cfg.lua
# use prosodyctl to start the server
prosody-x86_64.AppImage prosodyctl --config sample/prosody.cfg.lua start
Note: if you want to try the provided sample file, please first create directories samples/certs
and samples/data
.
The AppImage itself is a compressed archive. To avoid decompressing it everytime, or if Fuse is not available on your host,
you can decompression the AppImage using the --appimage-extract
parameters:
# decompress:
prosody-x86_64.AppImage --appimage-extract
# then run from the uncompressed path:
./squashfs-root/AppRun prosodyctl --config sample/prosody.cfg.lua status
Pre-requisite to build this repo:
- You must use a Debian-like system. Or at least have
apt
anddpkg
available on your system (you can manually install them). build-essential
python3-venv
squashfs-tools
Note: These dependencies were tested on a Debian Bullseye. If there is some dependencies issues on your UNIX/Linux system, please open an issue.
To build the AppImage, just run the build.sh
script.
Note: appimage-builder 1.1.0 has a bug for ARM64 builds. This bug was patched, but the patch was not released. So, for now, the build script makes a hot-patch. See aarch64 builds made from debian repository are not working for more information.
The build images will be in the dist
directory.