Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.95 KB

README.md

File metadata and controls

73 lines (50 loc) · 2.95 KB
Raw

prose-pod-server

Build and Release GitHub Release

Prose Pod server source code. Depends on the official Prosody XMPP server and extended for Prose requirements.

Copyright 2024, Prose Foundation - Released under the MIT License.

Installation

The Prose Pod server is ran from its Docker image. You can find the pre-built Prose Pod server image on Docker Hub as proseim/prose-pod-server.

First, pull the proseim/prose-pod-server image:

docker pull proseim/prose-pod-server:latest

Then, run it (feed it with its configuration and data storage directories):

docker run --rm \
  -p 5222:5222 \
  -p 5269:5269 \
  -p 5280:5280 \
  -v /host/path/to/etc/prosody/:/etc/prosody/ \
  -v /host/path/to/var/lib/prosody/:/var/lib/prosody/ \
  proseim/prose-pod-server

The following ports will be available on your host system:

  • 5222: XMPP client-to-server port (public port, open it on the public Internet)
  • 5269: XMPP server-to-server port (public port, open it on the public Internet)
  • 5280: HTTP services, eg. WebSocket endpoint (private port, keep it scoped to your host)

👉 The configurations can be sourced from the prose-pod-system repository.

If SSL certificates need to be generated, this can be done with the following commands eg.:

openssl req \
  -x509 \
  -newkey rsa:2048 \
  -keyout /host/path/to/etc/prosody/certs/prose.org.local.key \
  -out /host/path/to/etc/prosody/certs/prose.org.local.crt \
  -sha256 \
  -days 3650 \
  -nodes \
  -subj "/CN=prose.org.local" \
  -addext "subjectAltName = DNS:groups.prose.org.local"
  • Make sure to add the generate certificate to your keychain and mark it as trusted.
  • Also, add a section in /etc/hosts: 127.0.0.1 prose.org.local groups.prose.org.local

Build

To build the Prose Pod server Docker image locally, run:

docker build -t proseim/prose-pod-server .

License

Licensing information can be found in the COPYING document.

🔥 Report A Vulnerability

If you find a vulnerability in any Prose system, you are more than welcome to report it directly to Prose Security by sending an encrypted email to [email protected]. Do not report vulnerabilities in public GitHub issues, as they may be exploited by malicious people to target production systems running an unpatched version.

⚠️ You must encrypt your email using Prose Security GPG public key: 🔑57A5B260.pub.asc.