# HG changeset patch
# User Anthony Nowell <anowell@gmail.com>
# Date 1523547711 21600
# Node ID f6bde5107e489e86270175653be9930828d0f85b
# Parent  4263c1d83d5bc9cfae5949121f1c98a45973632c# Parent  cc32be79a94908d623d92ebfb42619512ba7f943
Merge pull request #1 from zbrox/master

Add simple README with example usage of pam-http

diff -r 4263c1d83d5b -r f6bde5107e48 pam-http/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/pam-http/README.md	Thu Apr 12 09:41:51 2018 -0600
@@ -0,0 +1,35 @@
+pam-http
+========
+
+A PAM HTTP BasicAuth module built using pam-rs
+
+# Prerequisites
+
+You need some libraries before you build like libpam and libssl.
+
+If you're going to build on Ubuntu, just run this:
+
+```
+sudo apt-get install -y build-essential libpam0g-dev libpam0g libssl-dev
+```
+
+# Building
+
+Just use `cargo build`.
+
+# Usage
+
+You need to move the build product to a folder where PAM is looking for modules.
+
+If you're using Ubuntu you can move `libpam_http.so` to `/lib/security`.
+After doing so you need to make sure it has proper permissions: `sudo chmod 755 /lib/security/libpam_http.so`.
+Then you can place a configuration file in `/etc/pam.d/`. It can look something like this:
+
+```
+auth sufficient libpam_http.so url=https://theserver.example.com/someendpoint
+account sufficient libpam_http.so
+```
+
+Make sure the endpoint you're specifying can receive GET requests and supports 
+[HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side). 
+If the user is authenticated successfully it should return HTTP 200.