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

Add how to build and run the project into readme

This commit is contained in:
Chteufleur 2016-08-09 22:58:28 +02:00
parent 78c8aecb8e
commit 7e9fd69879
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -5,18 +5,24 @@ Provide an HTTP anthentification over XMPP. Implementation of [XEP-0070](https:/
Can be run as a XMPP client or XMPP component. Can be run as a XMPP client or XMPP component.
## Compilation
### Dependencies ### Dependencies
* [go-xmpp](https://git.kingpenguin.tk/chteufleur/go-xmpp) for the XMPP part. * [go-xmpp](https://git.kingpenguin.tk/chteufleur/go-xmpp) for the XMPP part.
* [cfg](https://github.com/jimlawless/cfg) for the configuration file. * [cfg](https://github.com/jimlawless/cfg) for the configuration file.
### Build and run
You must first [install go environment](https://golang.org/doc/install) on your system. You must first [install go environment](https://golang.org/doc/install) on your system.
Then, go into your $GOPATH directory and go get the source code. Then, go into your $GOPATH directory and go get the source code.
```sh ```sh
go get git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP.git go get git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP.git
``` ```
First, you need to go into directory ``$GOPATH/src/chteufleur/HTTPAuthentificationOverXMPP.git``.
Then, you can run the project directly by using command ``go run main.go``.
Or, in order to build the project you can run the command ``go build main.go``.
It will generate a binary that you can run as any binary file.
### Configure ### Configure
Configure the gateway by editing the ``httpAuth.cfg`` file in order to give all XMPP and HTTP server informations. Configure the gateway by editing the ``httpAuth.cfg`` file in order to give all XMPP 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). An example of the config file can be found in [the repos](https://git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP/src/master/httpAuth.cfg).