diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 58 insertions, 6 deletions
@@ -1,20 +1,72 @@ + # xbot A Software to create simpel Chat Bots for the XMPP/Jabber Protocol. -## Current State +Until now this repository consists only of the ```xbot``` executable. To send a XMPP message from the command line, you can use it like this: + +``` +xbot -m "Hello from your XMPP bot" -j "recipient@example.com" +``` + +Additional functionality to interact with this quite simpel bot will probably be added. + + +## Expected Environment -This software is not ready to use. The first milestone is a simple terminal application which sends a message on a command like this: +- GNU/Linux Operating System +- The C libraries 'libiniparser' and 'libstrophe' are installed +- A build toolchain for C with gcc and make is available +- The user has to have root access via root to install the executable to the system + + +## Usage + +Install this software from source on GNU/Linux systems like this: ``` -xbot -m "Hello from your XMPP bot" -j "recipient@example.com" -p /path/to/my/xmpp/profile.ini +git clone https://gitea.xengineering.eu/xengineering/xbot.git +cd xbot +make all +make install ``` -Have a look at ```example_profile.ini``` to see how your own JID and password have to be formalized. +Make sure to have a XMPP account for you and your bot. There are a lot of free services available. Use your search engine of choice to find one or look at the links in the last section of this document. The same applies to XMPP clients. + +After the installation you have to edit ```~/.config/xbot/profile.ini``` to type in the XMPP credentials of your bot. Have a look at [example_profile.ini](example_profile.ini) to learn about the format. Then edit your file accordingly: + +``` +nano ~/.config/xbot/profile.ini +``` + +Now you are ready to go! Just use: + +``` +xbot -m "Hello from your XMPP bot" -j "recipient@example.com" +``` + +There are a few options for xbot available on the command line. You could for example enable debug output with ```-d``` or select another profile on your filesystem like this: + +``` +xbot -m "Hello from your XMPP bot" -j "recipient@example.com" -p /path/to/my/profile.ini -d +``` + +Little **disclaimer**: + +- Protect your profile.ini file. Set the correct access rights with ```chmod 600 path/to/my/profile.ini```. The installation with make takes already care of that. +- Currently there is no end-to-end encryption but transport encryption with TLS is enforced (maybe OMEMO encryption will be added in the future) + ## Links -- [XMPP Protocol Definition - RFC6120](https://xmpp.org/rfcs/rfc6120.html) -- [libstrophe Website with Doxygen Documentation](http://strophe.im/libstrophe/) +- XMPP protocol definition - [RFC6120](https://xmpp.org/rfcs/rfc6120.html) +- Website with doxygen documentation for the used XMPP library [libstrophe](http://strophe.im/libstrophe/) +- A free [XMPP service](https://conversations.im/) with an english website +- A free german [XMPP service](https://www.jabber.de/) +- Conversations is an Android client for XMPP. You can get it for free on [F-Droid](https://f-droid.org/en/packages/eu.siacs.conversations/) or buy it at the [Google Play Store](https://play.google.com/store/apps/details?id=eu.siacs.conversations) +- ChatSecure is an iOS client for XMPP. Get it in the [Apple App Store](https://apps.apple.com/us/app/chatsecure-messenger/id464200063) for free +- Gajim is a feature-rich client for XMPP designed for Windows, Linux and MacOS. Get it on their [Website](https://gajim.org/) +- Dino is a very young XMPP client for Linux which has just basic features but looks and works very well. They maintain a list of distribution packages accessible via their [website](https://dino.im/) +- The [Getting Started](https://xmpp.org/getting-started/) page of the XMPP Standards Foundation offers additional clients and information |