Add Readme and Unlicense

This commit is contained in:
Oliver Hattshire 2025-10-20 12:00:04 -03:00
parent 030d0f87a4
commit 93f55ea51a
2 changed files with 42 additions and 0 deletions

18
Readme.md Normal file
View file

@ -0,0 +1,18 @@
# Service[IM]: Prosody + Slidge
Simple XMPP deployment for legacy IM platforms interaction.
## Usage
### Setup
1. Set the `ADMIN_EMAIL` and `DOMAIN_NAME` variables in `.env`
2. Run `docker compose up -d`
3. Add a user with `docker compose exec -ti prosody prosodyctl adduser USERNAME@DOMAIN_NAME`
4. Enjoy
### Whatsapp Login
1. Start a chat with `whatsapp` as JID
2. Send `register`
3. Answer the questions
4. Scan the QR with the Whatsapp mobile app
5. Wait and chat