forked from mirror/prosody
Compare commits
43 commits
mod_pasteb
...
dev
Author | SHA1 | Date | |
---|---|---|---|
265fc16063 | |||
0eaf173701 | |||
|
4acb4b42a8 | ||
|
982ddcd60b | ||
|
0e33f70739 | ||
|
74c64514e2 | ||
|
d8e5906e55 | ||
|
fe1787f93c | ||
|
f8d0fe4f59 | ||
|
da2f438bda | ||
|
375b006814 | ||
|
e6415fa513 | ||
|
81e9c1abd9 | ||
|
f7fcfd5d88 | ||
|
ab2afd4249 | ||
|
bd7a27ea74 | ||
|
7a4ebd68d8 | ||
|
13d9c1b9d1 | ||
|
52e8f5388e | ||
|
75e4b05ce5 | ||
|
eab04aeaf0 | ||
|
ca4e265ffe | ||
|
4bbcdb80e9 | ||
|
1966b38aac | ||
|
80216c5fdc | ||
|
5bcf0fd3d0 | ||
|
aec0a30279 | ||
|
66723e19a1 | ||
|
dbc63cc00f | ||
|
39bd69d39c | ||
|
b70fcbd98e | ||
|
fc45a7bab1 | ||
|
d2915f77f3 | ||
|
357f4d4040 | ||
|
ade86ee812 | ||
|
58f5d18987 | ||
|
ceef3c335f | ||
|
1980cf0899 | ||
|
9645f521f8 | ||
|
606e63f20f | ||
|
15b95e5822 | ||
|
fb50f748ee | ||
|
fd21384bdf |
29 changed files with 874 additions and 113 deletions
26
.github/workflows/test.yml
vendored
Normal file
26
.github/workflows/test.yml
vendored
Normal file
|
@ -0,0 +1,26 @@
|
|||
name: Test
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: dev
|
||||
push:
|
||||
branches: dev
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository and submodules
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: install python3-venv
|
||||
run: sudo apt-get install python3-venv
|
||||
|
||||
- name: build test image
|
||||
run: docker build . -t prosody
|
||||
|
||||
- name: run tests
|
||||
run: cd ./tests/ && ./test.bash
|
5
.gitignore
vendored
5
.gitignore
vendored
|
@ -1 +1,4 @@
|
|||
data/*
|
||||
data/*
|
||||
tests/certs/
|
||||
tests/venv/
|
||||
tests/__pycache__/
|
||||
|
|
9
.gitmodules
vendored
Normal file
9
.gitmodules
vendored
Normal file
|
@ -0,0 +1,9 @@
|
|||
[submodule "tests/bats/bats-support"]
|
||||
path = tests/bats/bats-support
|
||||
url = https://github.com/bats-core/bats-support.git
|
||||
[submodule "tests/bats/bats-core"]
|
||||
path = tests/bats/bats-core
|
||||
url = https://github.com/bats-core/bats-core.git
|
||||
[submodule "tests/bats/bats-assert"]
|
||||
path = tests/bats/bats-assert
|
||||
url = https://github.com/bats-core/bats-assert.git
|
122
CHANGELOG.md
122
CHANGELOG.md
|
@ -2,7 +2,127 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
* Nothing yet
|
||||
### Adjust config
|
||||
|
||||
* Replace deprecated legacy_ssl with c2s_direct_tls.
|
||||
* Removed use_libevent = true. This means the default is now used which is epoll.
|
||||
|
||||
### Test
|
||||
|
||||
Added a test to check that no deprecated config settings are used.
|
||||
|
||||
## v1.3.0
|
||||
|
||||
* Updated to Prosody version [0.12.4](https://blog.prosody.im/prosody-0.12.4-released/)
|
||||
|
||||
### Breaking Change
|
||||
|
||||
Switched from [http_upload](https://modules.prosody.im/mod_http_upload) to [http_file_share](https://prosody.im/doc/modules/mod_http_file_share).
|
||||
This means that previous uploads will NOT work after upgrading.
|
||||
ENV variable `HTTP_UPLOAD_FILE_SIZE_LIMIT` was removed.
|
||||
|
||||
The new module uses the following variables:
|
||||
|
||||
* HTTP_FILE_SHARE_SIZE_LIMIT
|
||||
* HTTP_FILE_SHARE_DAILY_QUOTA
|
||||
|
||||
See [readme.md](readme.md) for explanations and defaults.
|
||||
|
||||
## v1.2.10
|
||||
|
||||
* Update docker base image to debian bookworm
|
||||
* [Add LDAP authentication support](https://github.com/SaraSmiseth/prosody/pull/50)
|
||||
* Add environment variable HTTP_MAX_CONTENT_SIZE for setting http_max_content_size.
|
||||
* Add environment variable HTTP_UPLOAD_FILE_SIZE_LIMIT for setting http_upload_file_size_limit.
|
||||
* Add domain_http_upload to disco_items to support http_upload on some clients and if http_upload is not a subdomain.
|
||||
|
||||
## v1.2.9
|
||||
|
||||
* Update prosody to version 0.12.3
|
||||
* Update luarocks to version 3.9.2
|
||||
|
||||
## v1.2.8
|
||||
|
||||
* Updated to Prosody version [0.12.1](https://blog.prosody.im/prosody-0.12.1-released/).
|
||||
|
||||
## v1.2.7
|
||||
|
||||
* Updated to Prosody version [0.12.0](https://blog.prosody.im/prosody-0.12.0-released/).
|
||||
* Updated luarocks to version 3.9.0.
|
||||
|
||||
## v1.2.6
|
||||
|
||||
* Updated to Prosody version [0.11.13](https://blog.prosody.im/prosody-0.11.13-released/).
|
||||
|
||||
## v1.2.5
|
||||
|
||||
* Updated to Prosody version [0.11.12](https://blog.prosody.im/prosody-0.11.12-released/).
|
||||
|
||||
## v1.2.4
|
||||
|
||||
* Updated to Prosody version [0.11.11](https://blog.prosody.im/prosody-0.11.11-released/).
|
||||
* Updated luarocks to version 3.8.0.
|
||||
|
||||
## v1.2.3
|
||||
|
||||
* Updated to Prosody version [0.11.10](https://blog.prosody.im/prosody-0.11.10-released/).
|
||||
|
||||
## v1.2.2
|
||||
|
||||
- Update debian from buster-slim to bullseye-slim (#27)
|
||||
|
||||
## v1.2.1
|
||||
|
||||
* Updated to Prosody version [0.11.9](https://blog.prosody.im/prosody-0.11.9-released/).
|
||||
|
||||
## v1.2.0
|
||||
|
||||
### New features
|
||||
|
||||
* New environment variables for database settings. It is now possible to use MariaDB or Postgres instead of SQLite. SQLite is the default. See [README](https://github.com/SaraSmiseth/prosody#environment-variables).
|
||||
|
||||
### Updates
|
||||
|
||||
* Updated luarocks to version 3.7.0.
|
||||
|
||||
## v1.1.4
|
||||
|
||||
### Updates
|
||||
|
||||
* Updated to Prosody version [0.11.8](https://blog.prosody.im/prosody-0.11.8-released/).
|
||||
* Updated luarocks to version 3.5.0.
|
||||
|
||||
## v1.1.3
|
||||
|
||||
### New features
|
||||
|
||||
* Set pidfile in prosody.cfg.lua.
|
||||
* Created a tests folder which contains pytest and bats tests.
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* Fixed using list ENV variables with multiple values.
|
||||
|
||||
## v1.1.2
|
||||
|
||||
### Updates
|
||||
|
||||
* Updated to Prosody version [0.11.7](https://blog.prosody.im/prosody-0.11.7-released/).
|
||||
* Updated luarocks to version 3.4.0.
|
||||
|
||||
### New features
|
||||
|
||||
* Made 04-server_contact_info.cfg.lua configurable with ENV variables. Fixes [#4](https://github.com/SaraSmiseth/prosody/issues/4).
|
||||
* Made 03-e2e-policy.cfg.lua configurable with ENV variables. Fixes [#9](https://github.com/SaraSmiseth/prosody/issues/9).
|
||||
* Added E2E_POLICY_WHITELIST ENV variable to configure e2e_policy_whitelist. Fixes [#10](https://github.com/SaraSmiseth/prosody/issues/10).
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* Cherry picked [commit](https://github.com/zipizap/prosody/commit/fa13a990a1b87745ae5f5fe8297cb0669f9e8779) from [zipizap/prosody](https://github.com/zipizap/prosody) which fixes a bug with env-vars not beeing initialized.
|
||||
|
||||
### Other changes
|
||||
|
||||
* Changed hashing of downloaded packages in Dockerfile to sha256.
|
||||
|
||||
## v1.1.1
|
||||
|
||||
|
|
61
Dockerfile
61
Dockerfile
|
@ -1,32 +1,56 @@
|
|||
FROM debian:buster-slim
|
||||
FROM debian:bookworm-slim
|
||||
|
||||
ARG BUILD_DATE
|
||||
ARG VCS_REF
|
||||
ARG VERSION
|
||||
|
||||
ARG LUAROCKS_VERSION=3.11.1
|
||||
ARG PROSODY_VERSION=0.12.4
|
||||
|
||||
ARG LUAROCKS_SHA256="c3fb3d960dffb2b2fe9de7e3cb004dc4d0b34bb3d342578af84f84325c669102"
|
||||
ARG PROSODY_DOWNLOAD_SHA256="47d712273c2f29558c412f6cdaec073260bbc26b7dda243db580330183d65856"
|
||||
|
||||
LABEL luarocks.version="${LUAROCKS_VERSION}"
|
||||
LABEL org.opencontainers.image.authors="Sara Smiseth"
|
||||
LABEL org.opencontainers.image.created="${BUILD_DATE}"
|
||||
LABEL org.opencontainers.image.description="This docker image provides you with a configured Prosody XMPP server."
|
||||
LABEL org.opencontainers.image.documentation="https://github.com/SaraSmiseth/prosody/blob/dev/readme.md"
|
||||
LABEL org.opencontainers.image.revision="${VCS_REF}"
|
||||
LABEL org.opencontainers.image.source="https://github.com/SaraSmiseth/prosody/archive/dev.zip"
|
||||
LABEL org.opencontainers.image.title="prosody"
|
||||
LABEL org.opencontainers.image.url="https://github.com/SaraSmiseth/prosody"
|
||||
LABEL org.opencontainers.image.vendor="Sara Smiseth"
|
||||
LABEL org.opencontainers.image.version="${VERSION}"
|
||||
LABEL prosody.version="${PROSODY_VERSION}"
|
||||
|
||||
RUN apt-get update \
|
||||
&& DEBIAN_FRONTEND=noninteractive apt-get install -y \
|
||||
libevent-dev `# this is no build dependency, but needed for luaevent` \
|
||||
libidn11 \
|
||||
libicu72 \
|
||||
libidn2-0 \
|
||||
libpq-dev \
|
||||
libsqlite3-0 \
|
||||
lua5.2 \
|
||||
lua-bitop \
|
||||
lua-dbi-mysql \
|
||||
lua-dbi-postgresql \
|
||||
lua-expat \
|
||||
lua-filesystem \
|
||||
lua-ldap \
|
||||
lua-socket \
|
||||
lua-sec \
|
||||
sqlite3 \
|
||||
lua-unbound \
|
||||
wget \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
ENV PROSODY_VERSION 0.11.6
|
||||
ENV PROSODY_DOWNLOAD_URL https://prosody.im/downloads/source/prosody-${PROSODY_VERSION}.tar.gz
|
||||
ENV PROSODY_DOWNLOAD_SHA1 3c24f3faf7735c570213da74eba6343c3afdf50d
|
||||
ENV LUAROCKS_VERSION 3.3.1
|
||||
|
||||
RUN buildDeps='gcc git libc6-dev libidn11-dev liblua5.2-dev libsqlite3-dev libssl-dev make unzip' \
|
||||
RUN buildDeps='gcc git libc6-dev libidn2-dev liblua5.2-dev libsqlite3-dev libssl-dev libicu-dev make unzip' \
|
||||
&& set -x \
|
||||
&& apt-get update && apt-get install -y $buildDeps --no-install-recommends \
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
\
|
||||
&& wget -O prosody.tar.gz "${PROSODY_DOWNLOAD_URL}" \
|
||||
&& echo "${PROSODY_DOWNLOAD_SHA1} *prosody.tar.gz" | sha1sum -c - \
|
||||
&& wget -O prosody.tar.gz "https://prosody.im/downloads/source/prosody-${PROSODY_VERSION}.tar.gz" \
|
||||
&& echo "${PROSODY_DOWNLOAD_SHA256} *prosody.tar.gz" | sha256sum -c - \
|
||||
&& mkdir -p /usr/src/prosody \
|
||||
&& tar -xzf prosody.tar.gz -C /usr/src/prosody --strip-components=1 \
|
||||
&& rm prosody.tar.gz \
|
||||
|
@ -38,6 +62,7 @@ RUN buildDeps='gcc git libc6-dev libidn11-dev liblua5.2-dev libsqlite3-dev libss
|
|||
&& mkdir /usr/src/luarocks \
|
||||
&& cd /usr/src/luarocks \
|
||||
&& wget https://luarocks.org/releases/luarocks-${LUAROCKS_VERSION}.tar.gz \
|
||||
&& echo "${LUAROCKS_SHA256} luarocks-${LUAROCKS_VERSION}.tar.gz" | sha256sum -c - \
|
||||
&& tar zxpf luarocks-${LUAROCKS_VERSION}.tar.gz \
|
||||
&& cd luarocks-${LUAROCKS_VERSION} \
|
||||
&& ./configure \
|
||||
|
@ -46,7 +71,9 @@ RUN buildDeps='gcc git libc6-dev libidn11-dev liblua5.2-dev libsqlite3-dev libss
|
|||
\
|
||||
&& luarocks install luaevent \
|
||||
&& luarocks install luadbi \
|
||||
`#&& luarocks install luadbi-mysql MYSQL_INCDIR=/usr/include/mariadb/` \
|
||||
&& luarocks install luadbi-sqlite3 \
|
||||
&& luarocks install stringy \
|
||||
\
|
||||
&& apt-get purge -y --auto-remove $buildDeps
|
||||
|
||||
|
@ -56,33 +83,31 @@ RUN groupadd -r prosody \
|
|||
&& useradd -r -g prosody prosody \
|
||||
&& chown prosody:prosody /usr/local/var/lib/prosody
|
||||
|
||||
RUN mkdir -p /var/run/prosody/ \
|
||||
&& chown prosody:prosody /var/run/prosody/
|
||||
|
||||
# https://github.com/prosody/prosody-docker/issues/25
|
||||
ENV __FLUSH_LOG yes
|
||||
|
||||
VOLUME ["/usr/local/var/lib/prosody"]
|
||||
|
||||
COPY prosody.cfg.lua /usr/local/etc/prosody/prosody.cfg.lua
|
||||
COPY docker-entrypoint.sh /entrypoint.sh
|
||||
COPY docker-entrypoint.bash /entrypoint.bash
|
||||
COPY conf.d/*.cfg.lua /usr/local/etc/prosody/conf.d/
|
||||
|
||||
COPY *.bash /usr/local/bin/
|
||||
|
||||
RUN download-prosody-modules.bash \
|
||||
&& docker-prosody-module-install.bash \
|
||||
bookmarks `# XEP-0411: Bookmarks Conversion` \
|
||||
carbons `# message carbons (XEP-0280)` \
|
||||
cloud_notify `# XEP-0357: Push Notifications` \
|
||||
csi `# client state indication (XEP-0352)` \
|
||||
e2e_policy `# require end-2-end encryption` \
|
||||
filter_chatstates `# disable "X is typing" type messages` \
|
||||
smacks `# stream management (XEP-0198)` \
|
||||
throttle_presence `# presence throttling in CSI` \
|
||||
http_upload `# file sharing (XEP-0363)` \
|
||||
vcard_muc `# XEP-0153: vCard-Based Avatar (MUC)` \
|
||||
&& rm -rf "/usr/src/prosody-modules"
|
||||
|
||||
USER prosody
|
||||
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
ENTRYPOINT ["/entrypoint.bash"]
|
||||
CMD ["prosody", "-F"]
|
||||
|
||||
|
|
|
@ -24,6 +24,7 @@ modules_enabled = {
|
|||
"ping"; -- Replies to XMPP pings with pongs
|
||||
"pep"; -- Enables users to publish their mood, activity, playing music and more
|
||||
"register"; -- Allow users to register on this server using a client and change passwords
|
||||
"turn_external"; -- Allow users to make voice/video calls
|
||||
--"muc"; -- [Loaded as component, therefore commented here] Multi-user chats (XEP-0045)
|
||||
|
||||
-- Admin interfaces
|
||||
|
|
|
@ -1,7 +1,12 @@
|
|||
default_storage = "sql"
|
||||
|
||||
sql = {
|
||||
driver = "SQLite3";
|
||||
database = "prosody.sqlite";
|
||||
driver = os.getenv("DB_DRIVER") or "SQLite3";
|
||||
database = os.getenv("DB_DATABASE") or "prosody.sqlite";
|
||||
host = os.getenv("DB_HOST");
|
||||
port = os.getenv("DB_PORT");
|
||||
username = os.getenv("DB_USERNAME");
|
||||
password = os.getenv("DB_PASSWORD");
|
||||
}
|
||||
|
||||
-- make 0.10-distributed mod_mam use sql store
|
||||
|
@ -15,3 +20,4 @@ storage = {
|
|||
-- https://modules.prosody.im/mod_mam.html
|
||||
archive_expires_after = "1y"
|
||||
|
||||
http_max_content_size = os.getenv("HTTP_MAX_CONTENT_SIZE") or 1024 * 1024 * 10 -- Default is 10MB
|
||||
|
|
|
@ -1,7 +1,12 @@
|
|||
e2e_policy_chat = "required"
|
||||
e2e_policy_muc = "required"
|
||||
e2e_policy_whitelist = {}
|
||||
local stringy = require "stringy"
|
||||
|
||||
e2e_policy_chat = os.getenv("E2E_POLICY_CHAT") or "required"
|
||||
e2e_policy_muc = os.getenv("E2E_POLICY_MUC") or "required"
|
||||
|
||||
local whitelist = os.getenv("E2E_POLICY_WHITELIST") or ""
|
||||
e2e_policy_whitelist = stringy.split(whitelist, ", ")
|
||||
|
||||
e2e_policy_message_optional_chat = "For security reasons, OMEMO, OTR or PGP encryption is STRONGLY recommended for conversations on this server."
|
||||
e2e_policy_message_required_chat = "For security reasons, OMEMO, OTR or PGP encryption is required for conversations on this server."
|
||||
e2e_policy_message_optional_muc = "For security reasons, OMEMO, OTR or PGP encryption is STRONGLY recommended for MUC on this server."
|
||||
e2e_policy_message_required_muc = "For security reasons, OMEMO, OTR or PGP encryption is required for MUC on this server."
|
||||
e2e_policy_message_required_muc = "For security reasons, OMEMO, OTR or PGP encryption is required for MUC on this server."
|
||||
|
|
|
@ -1,10 +1,18 @@
|
|||
local stringy = require "stringy"
|
||||
|
||||
local domain = os.getenv("DOMAIN")
|
||||
local abuse = os.getenv("SERVER_CONTACT_INFO_ABUSE") or "xmpp:abuse@" .. domain
|
||||
local admin = os.getenv("SERVER_CONTACT_INFO_ADMIN") or "xmpp:admin@" .. domain
|
||||
local feedback = os.getenv("SERVER_CONTACT_INFO_FEEDBACK") or "xmpp:feedback@" .. domain
|
||||
local sales = os.getenv("SERVER_CONTACT_INFO_SALES") or "xmpp:sales@" .. domain
|
||||
local security = os.getenv("SERVER_CONTACT_INFO_SECURITY") or "xmpp:security@" .. domain
|
||||
local support = os.getenv("SERVER_CONTACT_INFO_SUPPORT") or "xmpp:support@" .. domain
|
||||
|
||||
contact_info = {
|
||||
abuse = { "xmpp:abuse@" .. domain };
|
||||
admin = { "xmpp:admin@" .. domain };
|
||||
feedback = { "xmpp:feedback@" .. domain };
|
||||
sales = { "xmpp:sales@" .. domain };
|
||||
security = { "xmpp:security@" .. domain };
|
||||
support = { "xmpp:support@" .. domain };
|
||||
abuse = stringy.split(abuse, ", ");
|
||||
admin = stringy.split(admin, ", ");
|
||||
feedback = stringy.split(feedback, ", ");
|
||||
sales = stringy.split(sales, ", ");
|
||||
security = stringy.split(security, ", ");
|
||||
support = stringy.split(support, ", ");
|
||||
}
|
||||
|
|
|
@ -1,16 +1,16 @@
|
|||
local domain = os.getenv("DOMAIN")
|
||||
local domain_http_upload = os.getenv("DOMAIN_HTTP_UPLOAD")
|
||||
local domain_muc = os.getenv("DOMAIN_MUC")
|
||||
local domain_proxy = os.getenv("DOMAIN_PROXY")
|
||||
local domain_pubsub = os.getenv("DOMAIN_PUBSUB")
|
||||
local domain_http_upload = os.getenv("DOMAIN_HTTP_UPLOAD") or "upload." .. domain
|
||||
local domain_muc = os.getenv("DOMAIN_MUC") or "conference." .. domain
|
||||
local domain_proxy = os.getenv("DOMAIN_PROXY") or "proxy." .. domain
|
||||
local domain_pubsub = os.getenv("DOMAIN_PUBSUB") or "pubsub." .. domain
|
||||
|
||||
-- XEP-0368: SRV records for XMPP over TLS
|
||||
-- https://compliance.conversations.im/test/xep0368/
|
||||
legacy_ssl_ssl = {
|
||||
c2s_direct_tls_ssl = {
|
||||
certificate = "certs/" .. domain .. "/fullchain.pem";
|
||||
key = "certs/" .. domain .. "/privkey.pem";
|
||||
}
|
||||
legacy_ssl_ports = { 5223 }
|
||||
c2s_direct_tls_ports = { 5223 }
|
||||
|
||||
-- https://prosody.im/doc/certificates#service_certificates
|
||||
-- https://prosody.im/doc/ports#ssl_configuration
|
||||
|
@ -21,9 +21,20 @@ https_ssl = {
|
|||
|
||||
VirtualHost (domain)
|
||||
|
||||
turn_external_host = os.getenv("TURN_EXTERNAL_HOST") or "turn" .. domain;
|
||||
turn_external_port = os.getenv("TURN_EXTERNAL_PORT") or 3478;
|
||||
turn_external_secret = os.getenv("TURN_EXTERNAL_SECRET");
|
||||
|
||||
disco_items = {
|
||||
{ domain_http_upload },
|
||||
}
|
||||
|
||||
-- Set up a http file upload because proxy65 is not working in muc
|
||||
Component (domain_http_upload) "http_upload"
|
||||
http_upload_expire_after = 60 * 60 * 24 * 7 -- a week in seconds
|
||||
Component (domain_http_upload) "http_file_share"
|
||||
http_file_share_expires_after = 60 * 60 * 24 * 7 -- a week in seconds
|
||||
local size_limit = os.getenv("HTTP_FILE_SHARE_SIZE_LIMIT") or 10 * 1024 * 1024 -- Default is 10MB
|
||||
http_file_share_size_limit = size_limit
|
||||
http_file_share_daily_quota = os.getenv("HTTP_FILE_SHARE_DAILY_QUOTA") or 10 * size_limit -- Default is 10x the size limit
|
||||
|
||||
Component (domain_muc) "muc"
|
||||
name = "Prosody Chatrooms"
|
||||
|
@ -41,3 +52,6 @@ Component (domain_proxy) "proxy65"
|
|||
|
||||
-- Implements a XEP-0060 pubsub service.
|
||||
Component (domain_pubsub) "pubsub"
|
||||
|
||||
-- Set TURN server information.
|
||||
|
||||
|
|
18
docker-entrypoint.bash
Executable file
18
docker-entrypoint.bash
Executable file
|
@ -0,0 +1,18 @@
|
|||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
if [[ "$1" != "prosody" ]]; then
|
||||
exec prosodyctl $*
|
||||
exit 0;
|
||||
fi
|
||||
|
||||
if [ "$LOCAL" -a "$PASSWORD" -a "$DOMAIN" ] ; then
|
||||
prosodyctl register $LOCAL $DOMAIN $PASSWORD
|
||||
fi
|
||||
|
||||
if [ -z "$DOMAIN" ]; then
|
||||
echo "[ERROR] DOMAIN must be set!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
exec "$@"
|
|
@ -1,29 +0,0 @@
|
|||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
if [[ "$1" != "prosody" ]]; then
|
||||
exec prosodyctl $*
|
||||
exit 0;
|
||||
fi
|
||||
|
||||
if [ "$LOCAL" -a "$PASSWORD" -a "$DOMAIN" ] ; then
|
||||
prosodyctl register $LOCAL $DOMAIN $PASSWORD
|
||||
fi
|
||||
|
||||
if [ -z "$DOMAIN" ]; then
|
||||
echo "[ERROR] DOMAIN must be set!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
export ALLOW_REGISTRATION=${ALLOW_REGISTRATION:-true}
|
||||
export DOMAIN_HTTP_UPLOAD=${DOMAIN_HTTP_UPLOAD:-"upload.$DOMAIN"}
|
||||
export DOMAIN_MUC=${DOMAIN_MUC:-"conference.$DOMAIN"}
|
||||
export DOMAIN_PROXY=${DOMAIN_PROXY:-"proxy.$DOMAIN"}
|
||||
export DOMAIN_PUBSUB=${DOMAIN_PUBSUB:-"pubsub.$DOMAIN"}
|
||||
export LOG_LEVEL=${LOG_LEVEL:-"info"}
|
||||
export C2S_REQUIRE_ENCRYPTION=${C2S_REQUIRE_ENCRYPTION:-true}
|
||||
export S2S_REQUIRE_ENCRYPTION=${S2S_REQUIRE_ENCRYPTION:-true}
|
||||
export S2S_SECURE_AUTH=${S2S_SECURE_AUTH:-true}
|
||||
export PROSODY_ADMINS=${PROSODY_ADMINS:-""}
|
||||
|
||||
exec "$@"
|
|
@ -1,20 +1,33 @@
|
|||
-- see example config at https://hg.prosody.im/0.9/file/0.9.10/prosody.cfg.lua.dist
|
||||
-- easily extendable by putting into different config files within conf.d folder
|
||||
|
||||
admins = { os.getenv("PROSODY_ADMINS") };
|
||||
local stringy = require "stringy"
|
||||
|
||||
use_libevent = true; -- improves performance
|
||||
local prosody_admins = os.getenv("PROSODY_ADMINS") or "";
|
||||
admins = stringy.split(prosody_admins, ", ");
|
||||
|
||||
allow_registration = os.getenv("ALLOW_REGISTRATION");
|
||||
pidfile = "/var/run/prosody/prosody.pid"
|
||||
|
||||
c2s_require_encryption = os.getenv("C2S_REQUIRE_ENCRYPTION");
|
||||
s2s_require_encryption = os.getenv("S2S_REQUIRE_ENCRYPTION");
|
||||
s2s_secure_auth = os.getenv("S2S_SECURE_AUTH");
|
||||
allow_registration = os.getenv("ALLOW_REGISTRATION") or "true";
|
||||
|
||||
authentication = "internal_hashed";
|
||||
c2s_require_encryption = os.getenv("C2S_REQUIRE_ENCRYPTION") or "true";
|
||||
s2s_require_encryption = os.getenv("S2S_REQUIRE_ENCRYPTION") or "true";
|
||||
s2s_secure_auth = os.getenv("S2S_SECURE_AUTH") or "true";
|
||||
|
||||
authentication = os.getenv("AUTHENTICATION") or "internal_hashed";
|
||||
|
||||
ldap_base = os.getenv("LDAP_BASE");
|
||||
ldap_server = os.getenv("LDAP_SERVER") or "localhost";
|
||||
ldap_rootdn = os.getenv("LDAP_ROOTDN") or "";
|
||||
ldap_password = os.getenv("LDAP_PASSWORD") or "";
|
||||
ldap_filter = os.getenv("LDAP_FILTER") or "(uid=$user)";
|
||||
ldap_scope = os.getenv("LDAP_SCOPE") or "subtree";
|
||||
ldap_tls = os.getenv("LDAP_TLS") or "false";
|
||||
ldap_mode = os.getenv("LDAP_MODE") or "bind";
|
||||
ldap_admin_filter = os.getenv("LDAP_ADMIN_FILTER") or "";
|
||||
|
||||
log = {
|
||||
{levels = {min = os.getenv("LOG_LEVEL")}, to = "console"};
|
||||
{levels = {min = os.getenv("LOG_LEVEL") or "info"}, to = "console"};
|
||||
};
|
||||
|
||||
Include "conf.d/*.cfg.lua";
|
||||
|
|
102
readme.md
102
readme.md
|
@ -1,11 +1,13 @@
|
|||
# Prosody XMPP Docker image
|
||||
|
||||
![Docker](https://github.com/SaraSmiseth/prosody/workflows/Docker/badge.svg?branch=dev)
|
||||
[![docker image](https://images.microbadger.com/badges/image/sarasmiseth/prosody:latest.svg)](https://microbadger.com/images/sarasmiseth/prosody:latest)
|
||||
[![docker pulls](https://img.shields.io/docker/pulls/sarasmiseth/prosody.svg)](https://hub.docker.com/r/sarasmiseth/prosody/)
|
||||
[![docker stars](https://img.shields.io/docker/stars/sarasmiseth/prosody.svg)](https://hub.docker.com/r/sarasmiseth/prosody/)
|
||||
![Git repository size](https://img.shields.io/github/repo-size/SaraSmiseth/prosody)
|
||||
[![Docker pulls](https://img.shields.io/docker/pulls/sarasmiseth/prosody.svg)](https://hub.docker.com/r/sarasmiseth/prosody/)
|
||||
[![Docker stars](https://img.shields.io/docker/stars/sarasmiseth/prosody.svg)](https://hub.docker.com/r/sarasmiseth/prosody/)
|
||||
[![Github open issues](https://img.shields.io/github/issues-raw/SaraSmiseth/prosody)](https://github.com/SaraSmiseth/prosody/issues)
|
||||
[![Github open pull requests](https://img.shields.io/github/issues-pr-raw/SaraSmiseth/prosody)](https://github.com/SaraSmiseth/prosody/pulls)
|
||||
|
||||
This docker image provides you with a configured [Prosody](https://prosody.im/) XMPP server. The image is based on `debian:buster-slim`.
|
||||
This docker image provides you with a configured [Prosody](https://prosody.im/) XMPP server. The image is based on `debian:bookworm-slim`.
|
||||
The server was tested using the Android App [Conversations](https://conversations.im/) and the Desktop client [Gajim](https://gajim.org).
|
||||
Multiple [architectures](https://hub.docker.com/r/sarasmiseth/prosody/tags) are supported. I use it on my raspberry pi 4.
|
||||
|
||||
|
@ -34,11 +36,11 @@ While Conversations got everything set-up out-of-the-box, Gajim was used with th
|
|||
- [Symlinks](#symlinks)
|
||||
- [Permissions](#permissions)
|
||||
- [Run](#run)
|
||||
- [Volumes permissions](#volumes-permissions)
|
||||
- [Docker tags](#docker-tags)
|
||||
- [Configuration](#configuration)
|
||||
- [Environment variables](#environment-variables)
|
||||
- [DNS](#dns)
|
||||
- [server_contact_info](#server_contact_info)
|
||||
- [Extend](#extend)
|
||||
- [Upgrade](#upgrade)
|
||||
- [Test your server](#test-your-server)
|
||||
|
@ -139,6 +141,7 @@ For example ```cp -L src dest```.
|
|||
##### Permissions
|
||||
|
||||
See official [documentation](https://prosody.im/doc/certificates#permissions) for more information.
|
||||
Check [Volumes permissions](#volumes-permissions) as well.
|
||||
|
||||
### Run
|
||||
|
||||
|
@ -149,7 +152,7 @@ version: '3.7'
|
|||
|
||||
services:
|
||||
server:
|
||||
image: sarasmiseth/prosody:v1.0.0
|
||||
image: sarasmiseth/prosody:latest
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5000:5000"
|
||||
|
@ -164,9 +167,18 @@ services:
|
|||
- ./data:/usr/local/var/lib/prosody
|
||||
```
|
||||
|
||||
Boot it via: ```docker-compose up -d```.
|
||||
Boot it via: ```docker compose up -d```.
|
||||
|
||||
Inspect logs: ```docker-compose logs -f```.
|
||||
Inspect logs: ```docker compose logs -f```.
|
||||
|
||||
### Volumes permissions
|
||||
|
||||
The prosody user inside the container has the `uid=999` and `gid=999`. If you use the example `docker-compose.yml` from above make sure, that the `./data` folder and the `./certs` folder have the correct permissions.
|
||||
|
||||
``` shell
|
||||
sudo chown 999:999 ./certs
|
||||
sudo chown 999:999 ./data
|
||||
```
|
||||
|
||||
### Docker tags
|
||||
|
||||
|
@ -183,19 +195,50 @@ Inspect logs: ```docker-compose logs -f```.
|
|||
|
||||
#### Environment variables
|
||||
|
||||
| Variable | Description | Type | Default value |
|
||||
| -------------------------- | ------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
|
||||
| **ALLOW_REGISTRATION** | Whether to allow registration of new accounts via Jabber clients | *optional* | true |
|
||||
| **DOMAIN** | domain | **required** | null |
|
||||
| **DOMAIN_HTTP_UPLOAD** | Domain which lets clients upload files over HTTP | *optional* | upload.**DOMAIN** |
|
||||
| **DOMAIN_MUC** | Domain for Multi-user chat (MUC) for allowing you to create hosted chatrooms/conferences for XMPP users | *optional* | conference.**DOMAIN** |
|
||||
| **DOMAIN_PROXY** | Domain for SOCKS5 bytestream proxy for server-proxied file transfers | *optional* | proxy.**DOMAIN** |
|
||||
| **DOMAIN_PUBSUB** | Domain for a XEP-0060 pubsub service | *optional* | pubsub.**DOMAIN** |
|
||||
| **LOG_LEVEL** | Min log level. Change to debug for more information | *optional* | info |
|
||||
| **C2S_REQUIRE_ENCRYPTION** | Whether to force all client-to-server connections to be encrypted or not | *optional* | true |
|
||||
| **S2S_REQUIRE_ENCRYPTION** | Whether to force all server-to-server connections to be encrypted or not | *optional* | true |
|
||||
| **S2S_SECURE_AUTH** | Require encryption and certificate authentication | *optional* | true |
|
||||
| **PROSODY_ADMINS** | Specify who is an administrator. List of adresses. Eg. "me@example.com", "admin@example.net" | *optional* | "" |
|
||||
| Variable | Description | Type | Default value |
|
||||
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -------------------------- |
|
||||
| **ALLOW_REGISTRATION** | Whether to allow registration of new accounts via Jabber clients | *optional* | true |
|
||||
| **DOMAIN** | domain | **required** | null |
|
||||
| **DOMAIN_HTTP_UPLOAD** | Domain which lets clients upload files over HTTP | *optional* | upload.**DOMAIN** |
|
||||
| **DOMAIN_MUC** | Domain for Multi-user chat (MUC) for allowing you to create hosted chatrooms/conferences for XMPP users | *optional* | conference.**DOMAIN** |
|
||||
| **DOMAIN_PROXY** | Domain for SOCKS5 bytestream proxy for server-proxied file transfers | *optional* | proxy.**DOMAIN** |
|
||||
| **DOMAIN_PUBSUB** | Domain for a XEP-0060 pubsub service | *optional* | pubsub.**DOMAIN** |
|
||||
| **AUTHENTICATION** | authentication | *optional* | "internal_hashed" |
|
||||
| **LDAP_BASE** | LDAP base directory which stores user accounts | **required** if **AUTHENTICATION** is "ldap" | |
|
||||
| **LDAP_SERVER** | Space-separated list of hostnames or IPs, optionally with port numbers (e.g. “localhost:8389”) | *optional* | "localhost" |
|
||||
| **LDAP_ROOTDN** | The distinguished name to auth against | *optional* | "" |
|
||||
| **LDAP_PASSWORD** | Password for rootdn | *optional* | "" |
|
||||
| **LDAP_FILTER** | Search filter, with $user and $host substituted for user- and hostname | *optional* | "(uid=$user)" |
|
||||
| **LDAP_SCOPE** | Search scope. other values: “base” and “onelevel” | *optional* | "subtree" |
|
||||
| **LDAP_TLS** | Enable TLS (StartTLS) to connect to LDAP (can be true or false). The non-standard ‘LDAPS’ protocol is not supported. | *optional* | "false" |
|
||||
| **LDAP_MODE** | How passwords are validated. | *optional* | "bind" |
|
||||
| **LDAP_ADMIN_FILTER** | Search filter to match admins, works like ldap_filter | *optional* | "" |
|
||||
| **DB_DRIVER** | May also be "PostgreSQL" or "MySQL" or "SQLite3" (case sensitive!) | *optional* | SQLite3 |
|
||||
| **DB_DATABASE** | The database name to use. For SQLite3 this the database filename (relative to the data storage directory). | *optional* | prosody.sqlite |
|
||||
| **DB_HOST** | The address of the database server | *optional* | |
|
||||
| **DB_PORT** | Port on which the database is listening | *optional* | |
|
||||
| **DB_USERNAME** | The username to authenticate to the database | *optional* | |
|
||||
| **DB_PASSWORD** | The password to authenticate to the database | *optional* | |
|
||||
| **HTTP_MAX_CONTENT_SIZE** | Max http content size in bytes | *optional* | 10485760 |
|
||||
| **HTTP_FILE_SHARE_SIZE_LIMIT** | Max http file share size in bytes | *optional* | 10485760 |
|
||||
| **HTTP_FILE_SHARE_DAILY_QUOTA** | Daily quota in bytes | *optional* | 10 times share size limit |
|
||||
| **E2E_POLICY_CHAT** | Policy for chat messages. Possible values: "none", "optional" and "required". | *optional* | "required" |
|
||||
| **E2E_POLICY_MUC** | Policy for MUC messages. Possible values: "none", "optional" and "required". | *optional* | "required" |
|
||||
| **E2E_POLICY_WHITELIST** | Make this module ignore messages sent to and from this JIDs or MUCs. | *optional* | "" |
|
||||
| **LOG_LEVEL** | Min log level. Change to debug for more information | *optional* | info |
|
||||
| **C2S_REQUIRE_ENCRYPTION** | Whether to force all client-to-server connections to be encrypted or not | *optional* | true |
|
||||
| **S2S_REQUIRE_ENCRYPTION** | Whether to force all server-to-server connections to be encrypted or not | *optional* | true |
|
||||
| **S2S_SECURE_AUTH** | Require encryption and certificate authentication | *optional* | true |
|
||||
| **SERVER_CONTACT_INFO_ABUSE** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:abuse@**DOMAIN**" |
|
||||
| **SERVER_CONTACT_INFO_ADMIN** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:admin@**DOMAIN**" |
|
||||
| **SERVER_CONTACT_INFO_FEEDBACK** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:feedback@**DOMAIN**" |
|
||||
| **SERVER_CONTACT_INFO_SALES** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:sales@**DOMAIN**" |
|
||||
| **SERVER_CONTACT_INFO_SECURITY** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:security@**DOMAIN**" |
|
||||
| **SERVER_CONTACT_INFO_SUPPORT** | A list of strings. Each string should be an URI. See [here](https://prosody.im/doc/modules/mod_server_contact_info). | *optional* | "xmpp:support@**DOMAIN**" |
|
||||
| **TURN_EXTERNAL_HOST** | The external hostname for the TURN server. | *optional* | "turn.**DOMAIN**" |
|
||||
| **TURN_EXTERNAL_PORT** | The external port for the TURN server. | *optional* | "3478" |
|
||||
| **TURN_EXTERNAL_SECRET** | The external secret for the TURN server. | *optional* | "" |
|
||||
| **PROSODY_ADMINS** | Specify who is an administrator. List of adresses. Eg. "me@example.com", "admin@example.net" | *optional* | "" |
|
||||
|
||||
#### DNS
|
||||
|
||||
|
@ -206,24 +249,11 @@ You need these DNS record pointing to your server:
|
|||
* proxy.domain.tld
|
||||
* pubsub.domain.tld
|
||||
* upload.domain.tld
|
||||
* turn.domain.tld
|
||||
* A SRV record for _xmpps-client._tcp.domain.tld for port 5223.
|
||||
|
||||
where domain.tld is the environment variable DOMAIN.
|
||||
|
||||
#### server_contact_info
|
||||
|
||||
This module lets you advertise various contact addresses for your XMPP service via XEP-0157.
|
||||
It is configured for the following contacts:
|
||||
|
||||
* abuse
|
||||
* admin
|
||||
* feedback
|
||||
* sales
|
||||
* security
|
||||
* support
|
||||
|
||||
You can change them in [05-server_contact_info.cfg.lua](./conf.d/04-server_contact_info.cfg.lua).
|
||||
|
||||
### Extend
|
||||
|
||||
There is a helper script that eases installing additional prosody modules: ```docker-prosody-module-install```
|
||||
|
@ -239,7 +269,7 @@ If you need additional configuration just overwrite the respective _cfg.lua_ fil
|
|||
When migrating from prosody 0.10, you need to update the database once:
|
||||
|
||||
```bash
|
||||
docker-compose exec server bash
|
||||
docker compose exec server bash
|
||||
prosodyctl mod_storage_sql upgrade
|
||||
```
|
||||
|
||||
|
|
1
tests/bats/bats-assert
Submodule
1
tests/bats/bats-assert
Submodule
|
@ -0,0 +1 @@
|
|||
Subproject commit 397c735212bf1a06cfdd0cb7806c5a6ea79582bf
|
1
tests/bats/bats-core
Submodule
1
tests/bats/bats-core
Submodule
|
@ -0,0 +1 @@
|
|||
Subproject commit 410dd229a5ed005c68167cc90ed0712ad2a1c909
|
1
tests/bats/bats-support
Submodule
1
tests/bats/bats-support
Submodule
|
@ -0,0 +1 @@
|
|||
Subproject commit 3c8fadc5097c9acfc96d836dced2bb598e48b009
|
80
tests/docker-compose.yml
Normal file
80
tests/docker-compose.yml
Normal file
|
@ -0,0 +1,80 @@
|
|||
services:
|
||||
prosody:
|
||||
image: prosody
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5000:5000"
|
||||
- "5222:5222"
|
||||
- "5223:5223"
|
||||
- "5269:5269"
|
||||
- "5281:5281"
|
||||
environment:
|
||||
DOMAIN: example.com
|
||||
E2E_POLICY_WHITELIST: "admin@example.com, user1@example.com"
|
||||
LOG_LEVEL: debug
|
||||
PROSODY_ADMINS: "admin@example.com, admin2@example.com"
|
||||
volumes:
|
||||
- ./certs:/usr/local/etc/prosody/certs
|
||||
|
||||
prosody_postgres:
|
||||
image: prosody
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5000:5000"
|
||||
- "5222:5222"
|
||||
- "5223:5223"
|
||||
- "5269:5269"
|
||||
- "5281:5281"
|
||||
environment:
|
||||
DOMAIN: example.com
|
||||
E2E_POLICY_WHITELIST: "admin@example.com, user1@example.com"
|
||||
LOG_LEVEL: debug
|
||||
PROSODY_ADMINS: "admin@example.com, admin2@example.com"
|
||||
#DB_DRIVER: "MySQL"
|
||||
DB_DRIVER: "PostgreSQL"
|
||||
DB_DATABASE: "prosody"
|
||||
DB_HOST: "postgres"
|
||||
DB_PORT: "5432"
|
||||
DB_USERNAME: "prosody"
|
||||
DB_PASSWORD: "prosody"
|
||||
volumes:
|
||||
- ./certs:/usr/local/etc/prosody/certs
|
||||
depends_on:
|
||||
- postgres
|
||||
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: prosody
|
||||
POSTGRES_USER: prosody
|
||||
POSTGRES_PASSWORD: prosody
|
||||
|
||||
prosody_ldap:
|
||||
image: prosody
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5000:5000"
|
||||
- "5222:5222"
|
||||
- "5223:5223"
|
||||
- "5269:5269"
|
||||
- "5281:5281"
|
||||
environment:
|
||||
DOMAIN: example.com
|
||||
E2E_POLICY_WHITELIST: "admin@example.com, user1@example.com"
|
||||
LOG_LEVEL: debug
|
||||
PROSODY_ADMINS: "admin@example.com, admin2@example.com"
|
||||
AUTHENTICATION: "ldap"
|
||||
LDAP_BASE: "dc=example,dc=com"
|
||||
LDAP_SERVER: "glauth"
|
||||
LDAP_ROOTDN: "cn=svc,dc=example,dc=com"
|
||||
LDAP_PASSWORD: "12345678"
|
||||
volumes:
|
||||
- ./certs:/usr/local/etc/prosody/certs
|
||||
depends_on:
|
||||
- glauth
|
||||
|
||||
glauth:
|
||||
image: glauth/glauth
|
||||
volumes:
|
||||
- "./glauth/config.cfg:/app/config/config.cfg"
|
52
tests/glauth/config.cfg
Normal file
52
tests/glauth/config.cfg
Normal file
|
@ -0,0 +1,52 @@
|
|||
[ldap]
|
||||
enabled = true
|
||||
listen = "0.0.0.0:389"
|
||||
|
||||
[ldaps]
|
||||
enabled = false
|
||||
|
||||
[backend]
|
||||
datastore = "config"
|
||||
baseDN = "dc=example,dc=com"
|
||||
|
||||
[[groups]]
|
||||
name = "svc"
|
||||
gidnumber = 5500
|
||||
|
||||
[[groups]]
|
||||
name = "people"
|
||||
gidnumber = 5501
|
||||
|
||||
[[users]]
|
||||
name = "svc"
|
||||
uidnumber = 5000
|
||||
primarygroup = 5500
|
||||
passsha256 = "ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f"
|
||||
|
||||
[[users.capabilities]]
|
||||
action = "search"
|
||||
object = "*"
|
||||
|
||||
[[users]]
|
||||
name = "admin"
|
||||
uidnumber = 5001
|
||||
primarygroup = 5501
|
||||
passsha256 = "ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f"
|
||||
|
||||
[[users]]
|
||||
name = "user1"
|
||||
uidnumber = 5002
|
||||
primarygroup = 5501
|
||||
passsha256 = "ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f"
|
||||
|
||||
[[users]]
|
||||
name = "user2"
|
||||
uidnumber = 5003
|
||||
primarygroup = 5501
|
||||
passsha256 = "ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f"
|
||||
|
||||
[[users]]
|
||||
name = "user3"
|
||||
uidnumber = 5004
|
||||
primarygroup = 5501
|
||||
passsha256 = "ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f"
|
28
tests/readme.md
Normal file
28
tests/readme.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
# Tests
|
||||
|
||||
Pytest is used to login and send messages to other accounts.
|
||||
Bats is used to check the log for debug messages.
|
||||
|
||||
## Dependencies
|
||||
|
||||
* docker
|
||||
* docker-compose
|
||||
* python 3
|
||||
|
||||
## Run tests
|
||||
|
||||
Execute [`test.bash`](test.bash).
|
||||
|
||||
## Upgrade python packages
|
||||
|
||||
The following will install the newest version of packages in requirements.txt.
|
||||
|
||||
``` bash
|
||||
cat requirements.txt | sed 's/==.*//g' | xargs pip install -U
|
||||
```
|
||||
|
||||
If updates are available --> update and create new version with:
|
||||
|
||||
``` bash
|
||||
pip-chill > requirements.txt
|
||||
```
|
4
tests/requirements.txt
Normal file
4
tests/requirements.txt
Normal file
|
@ -0,0 +1,4 @@
|
|||
aioxmpp==0.13.3
|
||||
pip-chill==1.0.3
|
||||
pytest-asyncio==0.21.0
|
||||
pytz==2023.3
|
77
tests/test.bash
Executable file
77
tests/test.bash
Executable file
|
@ -0,0 +1,77 @@
|
|||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
|
||||
# generate certs for testing
|
||||
|
||||
generateCert() {
|
||||
local DOMAIN="$1"
|
||||
if [[ ! -d certs/"$DOMAIN" ]] ; then
|
||||
mkdir -p certs/"$DOMAIN"
|
||||
cd certs/"$DOMAIN"
|
||||
openssl req -x509 -newkey rsa:4096 -keyout privkey.pem -out fullchain.pem -days 365 -subj "/CN=$DOMAIN" -nodes
|
||||
chmod 777 *.pem
|
||||
cd ../../
|
||||
fi
|
||||
}
|
||||
|
||||
registerTestUser() {
|
||||
local userName="$1"
|
||||
local containerName="$2"
|
||||
echo "Registering TestUser '$userName' in container '$containerName'"
|
||||
sudo docker compose exec "$containerName" /bin/bash -c "prosodyctl register $userName example.com 12345678"
|
||||
}
|
||||
|
||||
registerTestUsers() {
|
||||
local containerName="$1"
|
||||
registerTestUser admin "$containerName"
|
||||
registerTestUser user1 "$containerName"
|
||||
registerTestUser user2 "$containerName"
|
||||
registerTestUser user3 "$containerName"
|
||||
}
|
||||
|
||||
runTests() {
|
||||
local containerName="$1"
|
||||
python --version \
|
||||
&& python3 --version \
|
||||
&& python3 -m venv venv \
|
||||
&& source venv/bin/activate \
|
||||
&& python --version \
|
||||
&& pip --version \
|
||||
&& pip install -r requirements.txt \
|
||||
&& pytest \
|
||||
&& deactivate \
|
||||
&& sleep 5 \
|
||||
&& sudo docker compose logs "$containerName" \
|
||||
&& export batsContainerName="$containerName" \
|
||||
&& ./bats/bats-core/bin/bats tests.bats \
|
||||
&& ./bats/bats-core/bin/bats tests-"$containerName".bats
|
||||
}
|
||||
|
||||
generateCert "example.com"
|
||||
generateCert "conference.example.com"
|
||||
generateCert "proxy.example.com"
|
||||
generateCert "pubsub.example.com"
|
||||
generateCert "upload.example.com"
|
||||
|
||||
# Run tests for first container with postgres
|
||||
# Start postgres first and wait for 10 seconds before starting prosody.
|
||||
sudo docker compose down
|
||||
sudo docker compose up -d postgres
|
||||
sleep 10
|
||||
sudo docker compose up -d prosody_postgres
|
||||
|
||||
registerTestUsers prosody_postgres
|
||||
runTests prosody_postgres
|
||||
sudo docker compose down
|
||||
|
||||
# Run tests for second container with SQLite
|
||||
sudo docker compose up -d prosody
|
||||
registerTestUsers prosody
|
||||
runTests prosody
|
||||
sudo docker compose down
|
||||
|
||||
# Run tests for prosody with ldap
|
||||
sudo docker compose up -d prosody_ldap
|
||||
runTests prosody_ldap
|
||||
sudo docker compose down
|
120
tests/test_prosody.py
Normal file
120
tests/test_prosody.py
Normal file
|
@ -0,0 +1,120 @@
|
|||
import aiosasl
|
||||
import aioxmpp
|
||||
import aioxmpp.dispatcher
|
||||
import asyncio
|
||||
import pytest
|
||||
|
||||
@pytest.fixture
|
||||
def client(client_username, password):
|
||||
|
||||
jid = aioxmpp.JID.fromstr(client_username)
|
||||
|
||||
client = aioxmpp.PresenceManagedClient(
|
||||
jid,
|
||||
aioxmpp.make_security_layer(
|
||||
password,
|
||||
no_verify=True
|
||||
),
|
||||
override_peer=[("localhost", 5222, aioxmpp.connector.STARTTLSConnector())],
|
||||
)
|
||||
return client
|
||||
|
||||
@pytest.fixture
|
||||
def client_with_message_dispatcher(client):
|
||||
def message_received(msg):
|
||||
print(msg)
|
||||
print(msg.body)
|
||||
assert msg.body == "Hello World!"
|
||||
|
||||
# obtain an instance of the service
|
||||
message_dispatcher = client.summon(
|
||||
aioxmpp.dispatcher.SimpleMessageDispatcher
|
||||
)
|
||||
|
||||
# register a message callback here
|
||||
message_dispatcher.register_callback(
|
||||
aioxmpp.MessageType.CHAT,
|
||||
None,
|
||||
message_received,
|
||||
)
|
||||
return client
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("admin@example.com", "12345678")])
|
||||
async def test_send_message_from_admin_to_user1(client):
|
||||
recipient_jid = aioxmpp.JID.fromstr("user1@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
# None is for "default language"
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("admin@example.com", "12345678")])
|
||||
async def test_send_message_from_admin_to_user2(client):
|
||||
recipient_jid = aioxmpp.JID.fromstr("user2@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("user1@example.com", "12345678")])
|
||||
async def test_send_message_from_user1_to_user2(client):
|
||||
recipient_jid = aioxmpp.JID.fromstr("user2@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("user2@example.com", "12345678")])
|
||||
async def test_send_message_from_user2_to_user3(client):
|
||||
recipient_jid = aioxmpp.JID.fromstr("user3@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("user2@example.com", "12345678")])
|
||||
async def test_send_message_from_user2_to_nonexisting(client):
|
||||
recipient_jid = aioxmpp.JID.fromstr("nonexisting@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize("client_username, password", [("user2@example.com", "wrong password")])
|
||||
async def test_can_not_log_in_with_wrong_password(client):
|
||||
with pytest.raises(aiosasl.AuthenticationFailure):
|
||||
recipient_jid = aioxmpp.JID.fromstr("nonexisting@example.com")
|
||||
async with client.connected() as stream:
|
||||
msg = aioxmpp.Message(
|
||||
to=recipient_jid,
|
||||
type_=aioxmpp.MessageType.CHAT,
|
||||
)
|
||||
msg.body[None] = "Hello World!"
|
||||
|
||||
await client.send(msg)
|
10
tests/tests-prosody.bats
Normal file
10
tests/tests-prosody.bats
Normal file
|
@ -0,0 +1,10 @@
|
|||
# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
|
||||
|
||||
load 'bats/bats-support/load'
|
||||
load 'bats/bats-assert/load'
|
||||
|
||||
@test "Should use sqlite" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Connecting to \[SQLite3\] \/usr\/local\/var\/lib\/prosody\/prosody\.sqlite\.\.\.\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
16
tests/tests-prosody_ldap.bats
Normal file
16
tests/tests-prosody_ldap.bats
Normal file
|
@ -0,0 +1,16 @@
|
|||
# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
|
||||
|
||||
load 'bats/bats-support/load'
|
||||
load 'bats/bats-assert/load'
|
||||
|
||||
@test "Should use sqlite" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Connecting to \[SQLite3\] \/usr\/local\/var\/lib\/prosody\/prosody\.sqlite\.\.\.\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should use ldap" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Host 'example.com' now set to use user provider 'ldap'\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
10
tests/tests-prosody_postgres.bats
Normal file
10
tests/tests-prosody_postgres.bats
Normal file
|
@ -0,0 +1,10 @@
|
|||
# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
|
||||
|
||||
load 'bats/bats-support/load'
|
||||
load 'bats/bats-assert/load'
|
||||
|
||||
@test "Should use postgres" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Connecting to \[PostgreSQL\] prosody\.\.\.\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
98
tests/tests.bats
Normal file
98
tests/tests.bats
Normal file
|
@ -0,0 +1,98 @@
|
|||
# For tests with pipes see: https://github.com/sstephenson/bats/issues/10
|
||||
|
||||
load 'bats/bats-support/load'
|
||||
load 'bats/bats-assert/load'
|
||||
|
||||
@test "Should send 5 messages" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Received\[c2s\]: <message\" | wc -l"
|
||||
assert_success
|
||||
assert_output "5"
|
||||
}
|
||||
|
||||
@test "Should select certificate for example.com" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Certificates loaded\" | grep \" example.com:tls\" | wc -l"
|
||||
assert_success
|
||||
assert_output "1"
|
||||
}
|
||||
|
||||
@test "Should select certificate for conference.example.com" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Certificates loaded\" | grep \"conference.example.com:tls\" | wc -l"
|
||||
assert_success
|
||||
assert_output "1"
|
||||
}
|
||||
|
||||
@test "Should select certificate for proxy.example.com" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Certificates loaded\" | grep \"proxy.example.com:tls\" | wc -l"
|
||||
assert_success
|
||||
assert_output "1"
|
||||
}
|
||||
|
||||
@test "Should select certificate for pubsub.example.com" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Certificates loaded\" | grep \"pubsub.example.com:tls\" | wc -l"
|
||||
assert_success
|
||||
assert_output "1"
|
||||
}
|
||||
|
||||
@test "Should select certificate for upload.example.com" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Certificates loaded\" | grep \"upload.example.com:tls\" | wc -l"
|
||||
assert_success
|
||||
assert_output "1"
|
||||
}
|
||||
|
||||
@test "Should log error for user with wrong password" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Session closed by remote with error: undefined-condition (user intervention: authentication failed: authentication aborted by user)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should activate s2s" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Activated service 's2s' on (\[::\]:5269|\[\*\]:5269), (\[::\]:5269|\[\*\]:5269)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should activate c2s" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Activated service 'c2s' on (\[::\]:5222|\[\*\]:5222), (\[::\]:5222|\[\*\]:5222)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should activate c2s_direct_tls" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Activated service 'c2s_direct_tls' on (\[::\]:5223|\[\*\]:5223), (\[::\]:5223|\[\*\]:5223)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should activate proxy65" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Activated service 'proxy65' on (\[::\]:5000|\[\*\]:5000), (\[::\]:5000|\[\*\]:5000)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should activate https" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"Activated service 'https' on (\[::\]:5281|\[\*\]:5281), (\[::\]:5281|\[\*\]:5281)\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should load module cloud_notify" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"example.com:cloud_notify.*info.*Module loaded\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should show upload URL" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep \"Serving 'file_share' at https:\/\/upload.example.com:5281\/file_share\""
|
||||
assert_success
|
||||
assert_output
|
||||
}
|
||||
|
||||
@test "Should not use deprecated config" {
|
||||
run bash -c "sudo docker compose exec $batsContainerName /bin/bash -c \"/entrypoint.bash check\" | grep 'deprecated' -A 3"
|
||||
assert_failure
|
||||
}
|
||||
|
||||
@test "Should not have warnings in log" {
|
||||
run bash -c "sudo docker compose logs $batsContainerName | grep -E \"warn\""
|
||||
assert_failure
|
||||
}
|
14
update-dependencies.sh
Executable file
14
update-dependencies.sh
Executable file
|
@ -0,0 +1,14 @@
|
|||
#!/bin/zsh
|
||||
|
||||
update_luarocks() {
|
||||
# Get latest luarocks version and calculate sha256 hash of the tarball
|
||||
local LUAROCKS_VER=$(wget -q -O - 'https://api.github.com/repos/luarocks/luarocks/tags' | jq -r ".[0].name")
|
||||
local LUAROCKS_VER=${LUAROCKS_VER#v}
|
||||
local LUAROCKS_SHA256_HASH=$(wget -q -O - "https://luarocks.org/releases/luarocks-$LUAROCKS_VER.tar.gz" | sha256sum --zero | perl -lane 'print $F[0]')
|
||||
|
||||
# Update Dockerfile
|
||||
perl -pi -e "s/LUAROCKS_VERSION=\K.*/$LUAROCKS_VER/" Dockerfile
|
||||
perl -pi -e "s/LUAROCKS_SHA256=\K.*/\"$LUAROCKS_SHA256_HASH\"/" Dockerfile
|
||||
}
|
||||
|
||||
update_luarocks
|
Loading…
Reference in a new issue