A REST API to fetch XMPP vCards using a NodeJS backend. Based on the repository by skorotkiewicz [0]. [0] https://github.com/skorotkiewicz/node-xmpp-vcard
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Yarmo Mackenbach 502541e2b1 Release 1.1.0 2 months ago
.gitignore Simplify gitignore 2 months ago
Dockerfile Add code 2 months ago
LICENSE Initial commit 2 months ago
README.md Improve README 2 months ago
docker-compose.yml Minor changes 2 months ago
index.js Minor changes 2 months ago
package-lock.json Release 1.1.0 2 months ago
package.json Release 1.1.0 2 months ago
template.env Add template .env file 2 months ago

README.md

node-xmpp-vcard

A REST API to fetch XMPP vCards using a NodeJS backend.

Based on the repository by skorotkiewicz [0].

[0] https://github.com/skorotkiewicz/node-xmpp-vcard

Install

Preparation

  • Make a dedicated account on a XMPP server (not all work, https://404.city is known to work);
  • Update the environment variables using the credentials of the account during the installation process below.

Install directly

git clone https://codeberg.org/keyoxide/node-xmpp-vcard
mv template.env .env
nano .env
npm install
npm start

Install using docker

git clone https://codeberg.org/keyoxide/node-xmpp-vcard
mv template.env .env
nano .env
docker build -t node-xmpp-vcard .
docker run -p 3000:3000 -e NODE_ENV=production -d node-xmpp-vcard

Install using docker-compose

git clone https://codeberg.org/keyoxide/node-xmpp-vcard
nano docker-compose.yml
docker-compose up -d

Usage

/api/vcard/:jid/:data

Data

:data description
FN Full name
NUMBER Phone number
USERID Mail
URL Website
BDAY Birthday
NICKNAME Nickname
DESC Description