Edit README.md with python usage; Edit userEnv.py.template

This commit is contained in:
poka 2020-11-20 05:12:58 +01:00
parent 317c666fca
commit dea707babf
2 changed files with 37 additions and 27 deletions

View File

@ -1,53 +1,62 @@
# Utilisation de la messagerie Cesium+/Gchange # Utilisation de la messagerie Cesium+/Gchange
## Réception/Envoi/Suppression de messages ## Réception/Envoi/Suppression de messages
## Installation
Linux:
```
bash setup.sh
```
Autre:
```
Débrouillez-vous.
```
## Utilisation ## Utilisation
``` Renseignez le fichier userEnv.py (Généré lors de la première tentative d'execution, ou à copier depuis userEnv.py.template).
chmod u+x readmsg.sh sendmsg.sh deletemsg.sh
```
Par défaut utilise l'émetteur, le fichier de trousseau ainsi que le noeud Cesium+ indiqué dans le fichier `.env`.
Si non renseigné ni dans le fichier `.env` ni en argument de la commande, alors ils seront demandés interactivement.
### Lecture des messages ### Lecture des messages
``` ```
./readmsg.sh ./dialog.py read
``` ```
_Options_: _Options_:
``` ```
-r,--recipient <pubkey> Uses <pubkey> as recipient of the messages. -h, --help show this help message and exit
-k,--key <key> Path <key> to the pubsec keychain file of the issuer. -n NUMBER, --number NUMBER
-n,--number <number> Display the <number> lasts messages from Cesium (tail-like format) Affiche les NUMBER derniers messages
-o,--outbox Read outbox messages instead of inbox -o, --outbox Lit les messages envoyés
-h,--help Display this help
``` ```
### Envoi de messages ### Envoi de messages
``` ```
./sendmsg.sh ./dialog.py send -d DESTINATAIRE
``` ```
_Options_: _Options_:
``` ```
-t Test mode: Uses the "test.txt" file as well as the same recipient as the sender. -h, --help show this help message and exit
-f,--file <file> Read the file <file> with title in first line and content in rest of the file for the message. -d DESTINATAIRE, --destinataire DESTINATAIRE
-r,--recipient <pubkey> Uses <pubkey> as recipient of the message. Destinataire du message
-i,--issuer <pubkey> Uses <pubkey> as issuer of the message (Could be remove in future version by calculating pubkey from privatekey). -t TITRE, --titre TITRE
-k,--key <key> Path <key> to the pubsec keychain file of the issuer. Titre du message à envoyer
-h,--help Display this help -m MESSAGE, --message MESSAGE
Message à envoyer
-f FICHIER, --fichier FICHIER
Envoyer le message contenu dans le fichier 'FICHIER'
-o, --outbox Envoi le message sur la boite d'envoi
``` ```
### Suppression de messages ### Suppression de messages
``` ```
./deletemsg.sh ./dialog.py delete -i ID
``` ```
_Options_: _Options_:
``` ```
-id,--id <ID du message> Delete the message with ID <id>. -h, --help show this help message and exit
-i,--issuer <pubkey> Uses <pubkey> as issuer of the message. -i ID, --id ID ID du message à supprimer
-k,--key <key> Path <key> to the pubsec keychain file of the issuer. -o, --outbox Suppression d'un message envoyé
-o,--outbox Delete outbox messages instead of inbox
-h,--help Display this help
``` ```

View File

@ -1,3 +1,4 @@
dunikey = "" # Chemin de la clé privé Ḡ1 de l'émetteur, au format PubSec dunikey = "" # Chemin de la clé privé Ḡ1 de l'émetteur, au format PubSec
pod = "https://g1.data.duniter.fr" # Adresse du pod Cesium ou Gchange à utiliser #pod = "https://g1.data.duniter.fr" # Adresse du pod Cesium à utiliser
#pod = "https://data.gchange.fr" pod = "https://g1.data.le-sou.org" # Adresse du pod Cesium de secours
#pod = "https://data.gchange.fr" # Adresse du pod GChange à utiliser