XMPP Providers Website

providers.xmpp.net is a website generated based on data from the XMPP Providers project.

Changes of the provider data may take a while to become visible on the website. This is due to some delay in building and deploying.

1. The filtered lists are provided by https://invent.kde.org/melvo/xmpp-providers
2. The website is deployed by the server on xmpp.net (every hour)

Software Requirements

• hugo
• python >=3.11

Development

Building the Website

To run a development server on your local computer, follow these basic steps:

git clone https://github.com/xsf/xmpp-providers-website.git
# install Hugo
cd xmpp-providers-website

Running the server in development mode (reloads whenever a file is changed):

make serve

or, to use installed dependencies instead of using pip:

make serve-no-pip

View at http://localhost:1313

Run via Docker

docker build -t xmpp-providers -f ./Dockerfile .
docker run -p 80:80 -t -i xmpp-providers

If you want to change Hugo’s baseURL for the generated website, build the image with --build-arg BASEURL=http://yoururl/ set, for example with http://localhost/:

docker build -t xmpp-providers --build-arg BASEURL=http://localhost/ -f ./Dockerfile .

Hugo Static Site Generator

Hugo’s quickstart page is a good place to learn about the basics of Hugo (installation, project skeleton, development cycle, etc.).

Theme

This website makes use of:

• Bootstrap 5.3
• FontAwesome 6

API Levels

Currently, this website is based on the v2 version of the Providers API.

When moving to another API version, URLs have to be changed in both Dockerfile and tools/prepare.py.