chteufleur
/
HTTPAuthentificationOverXMPP
1
1
Fork 1
Code Issues 5 Pull Requests Releases Wiki Activity

Add in README where to find a config file example

This commit is contained in:
Chteufleur 2016-07-18 18:22:08 +02:00
parent 0f64210e16
commit 4a4bcb418b
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -16,7 +16,7 @@ go get git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP.git
``` ```
### Configure ### Configure
Configure the gateway by editing the ``httpAuth.cfg`` file in order to give all XMPP component and HTTP server informations. Configure the gateway by editing the ``httpAuth.cfg`` file in order to give all XMPP component and HTTP server informations. An example of the config file can be found in [the repos](https://git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP/src/master/httpAuth.cfg).
XMPP XMPP
* xmpp_server_address : Component server address connection (default: 127.0.0.1) * xmpp_server_address : Component server address connection (default: 127.0.0.1)
@ -32,6 +32,7 @@ HTTP
* https_key_path : Path to the key file (default: ./key.pem) * https_key_path : Path to the key file (default: ./key.pem)
* http_timeoute_sec : Define a timeout if user did not give an answer to the request (default: 60) * http_timeoute_sec : Define a timeout if user did not give an answer to the request (default: 60)
### Utilization ### Utilization
To ask authorization, just send an HTTP request to the path ``/auth`` with parameters: To ask authorization, just send an HTTP request to the path ``/auth`` with parameters:
* jid : JID of the user (user@host/resource or user@host) * jid : JID of the user (user@host/resource or user@host)