prosody/README.md at 160c552809224131ca285f7853471ae37dab88d3

casjaysdevdocker/prosody

0 Fork 0

mirror of https://github.com/casjaysdevdocker/prosody synced 2026-11-12 03:22:28 -05:00

Files

T

casjay 160c552809

✨ Implement ENABLE_REGISTRATION via user_api module ✨

- docker/rootfs/usr/local/share/prosody-plugins/mod_user_api.lua: new POST /user-api/register endpoint (JSON, validation, reserved names, per-IP rate limit, refuses when AUTH_TYPE is not internal)
- docker/rootfs/usr/local/bin/entrypoint.sh: read ENABLE_REGISTRATION, load user_api on the main host only when ENABLE_AUTH is on, warn otherwise
- docker/compose.yml: add ENABLE_REGISTRATION
- README.md: document registration

2026-11-08 10:34:11 -05:00

3.0 KiB

Raw Blame History

👋 Welcome to prosody 🚀

prosody README

Install my system scripts

 sudo bash -c "$(curl -q -LSsf "https://github.com/systemmgr/installer/raw/main/install.sh")"
 sudo systemmgr --config && sudo systemmgr install scripts

Automatic install/update

dockermgr update prosody

Install and run container

dockerHome="/srv/$USER/docker/casjaysdevdocker/prosody/prosody/latest/volumes"
mkdir -p "/srv/$USER/docker/prosody/volumes"
git clone "https://github.com/dockermgr/prosody" "$HOME/.local/share/CasjaysDev/dockermgr/prosody"
cp -Rfva "$HOME/.local/share/CasjaysDev/dockermgr/prosody/volumes/." "$dockerHome/"
docker run -d \
--restart always \
--privileged \
--name casjaysdevdocker-prosody-latest \
--hostname prosody \
-e TZ=${TIMEZONE:-America/New_York} \
-v "$dockerHome/data:/data:z" \
-v "$dockerHome/config:/config:z" \
-p 80:80 \
casjaysdevdocker/prosody:latest

via docker-compose

version: "2"
services:
  ProjectName:
    image: casjaysdevdocker/prosody
    container_name: casjaysdevdocker-prosody
    environment:
      - TZ=America/New_York
      - HOSTNAME=prosody
    volumes:
      - "/srv/$USER/docker/casjaysdevdocker/prosody/prosody/latest/volumes/data:/data:z"
      - "/srv/$USER/docker/casjaysdevdocker/prosody/prosody/latest/volumes/config:/config:z"
    ports:
      - 80:80
    restart: always

Get source files

dockermgr download src casjaysdevdocker/prosody

git clone "https://github.com/casjaysdevdocker/prosody" "$HOME/Projects/github/casjaysdevdocker/prosody"

Build container

cd "$HOME/Projects/github/casjaysdevdocker/prosody"
buildx

Authors

🤖 casjay: Github 🤖
⛵ casjaysdevdocker: Github Docker ⛵

Authentication

Variable	Default	Meaning
`AUTH_TYPE`	`internal`	`internal` = local accounts only; `openfire` = local accounts, then Openfire
`OPENFIRE_AUTH_HOST`	`172.17.0.1`	Openfire direct-TLS c2s host (certificate and hostname verified)
`OPENFIRE_AUTH_PORT`	`5223`	Openfire direct-TLS c2s port
`OPENFIRE_AUTH_DOMAIN`	empty	Openfire XMPP domain (required for `AUTH_TYPE=openfire`)
`OPENFIRE_AUTH_EXCLUDE`	`focus,jvb,jibri,recorder`	Service accounts that never use Openfire

Service accounts (focus, jvb, jibri, jigasi) always use local internal_hashed.
Only SASL PLAIN is offered with openfire, since an external check cannot do SCRAM.

Registration

Variable	Default	Meaning
`ENABLE_REGISTRATION`	`0`	Serve `POST /user-api/register` (used by the jitsi-web `/register` page)

Requires ENABLE_AUTH=1 and AUTH_TYPE=internal; otherwise it is ignored (with a warning) or refused (403).
Rate limited to 5 attempts per IP per hour; reserved names (admin, focus, jvb, ...) are rejected.

3.0 KiB Raw Blame History