Add Readme and Unlicense
This commit is contained in:
parent
030d0f87a4
commit
93f55ea51a
2 changed files with 42 additions and 0 deletions
18
Readme.md
Normal file
18
Readme.md
Normal 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
|
||||
24
UNLICENSE
Normal file
24
UNLICENSE
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
This is free and unencumbered software released into the public domain.
|
||||
|
||||
Anyone is free to copy, modify, publish, use, compile, sell, or
|
||||
distribute this software, either in source code form or as a compiled
|
||||
binary, for any purpose, commercial or non-commercial, and by any
|
||||
means.
|
||||
|
||||
In jurisdictions that recognize copyright laws, the author or authors
|
||||
of this software dedicate any and all copyright interest in the
|
||||
software to the public domain. We make this dedication for the benefit
|
||||
of the public at large and to the detriment of our heirs and
|
||||
successors. We intend this dedication to be an overt act of
|
||||
relinquishment in perpetuity of all present and future rights to this
|
||||
software under copyright law.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||||
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
||||
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
For more information, please refer to <https://unlicense.org/>
|
||||
Loading…
Add table
Add a link
Reference in a new issue