Commit ce038421 authored by jnanar's avatar jnanar

Add config example to publish in microblog node.

The messages are therefore visible in XMPP clients that support microblogging (Salut à toi, movim, ...).

This option requires persistent pep module.
parent d78df28c
......@@ -2,7 +2,7 @@
Errol is a file sender that rely on [inotify](https://en.wikipedia.org/wiki/Inotify). It can be used to watch a directory and automatically transfers the new files (or modified ones) with XMPP.
### Prerequisites
## Prerequisites
Errol needs the following requirements:
......@@ -41,6 +41,7 @@ send_last_published_item: on_sub
### Tests
You can test your setup with the examples scripts of [slixmpp](https://git.poez.io/slixmpp).
* [pubsub_client.py](https://git.poez.io/slixmpp/tree/examples/pubsub_client.py)
* [pubsub_events.py](https://git.poez.io/slixmpp/tree/examples/pubsub_events.py)
* [s5b_receiver.py](https://git.poez.io/slixmpp/tree/examples/s5b_transfer/s5b_receiver.py)
......@@ -59,12 +60,12 @@ See the scripts for more information.
First you need to clone the repository.
Errol needs the following dependencies:
*[slixmpp](https://dev.louiz.org/projects/slixmpp) (python 3 only)
* [slixmpp](https://dev.louiz.org/projects/slixmpp) (python 3 only)
* [asyncio ](https://docs.python.org/3/library/asyncio.html)
* [configparser](https://docs.python.org/3/library/configparser.html)
* [aionotify](https://github.com/rbarrois/aionotify)
### Installing
## Installing
You can install errol easily in a [virtualenv](https://virtualenv.pypa.io/en/stable/userguide/) or not:
```
......@@ -77,7 +78,7 @@ On Archlinux:
A PKGBUILD will be available soon.
```
### Configuration
## Configuration
You need to provide information about the XMPP account.
......@@ -106,7 +107,7 @@ The files will be sent by jid@example.org/errol-0 and received by jid@example.or
. The nicks are the usernames used on the MUC.
### Running
## Running
Once installed, Errol can be launched in a terminal.
......@@ -128,7 +129,7 @@ optional arguments:
The executed command: xmpp or watcher
```
#### On device A
### On device A
If you want to watch the directory /tmp/sender, the following command can be used:
```
......@@ -137,7 +138,7 @@ $ errol -f config.example.ini -p /tmp/sender -c watcher
All modified or new files created in the watched location will be sent by XMPP.
#### On device B
### On device B
If you want to receive the files, you have to launch Errol with the following command line.
```
......
[XMPP]
pubsub=jid@example.org
node=urn:xmpp:microblog:0
room=chat@chat.example.org
jid=jid@example.org/errol
password=pass
ressource_receiver=-receiver
ressource_sender=-
nick_sender=errol_sender
nick_receiver=errol_receiver
receiver=jid@example.org/errol-receiver
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment