aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2016-11-20 16:10:37 +0100
committerGuido Günther <agx@sigxcpu.org>2016-11-20 16:15:52 +0100
commitef6e4115e7182e9b2581b5805e136c22cae02aa0 (patch)
treeeac6492c766c1137b97ec82d5745dd74912d3af5
parent23c857ff898bbae9853e1946edd7a59fa8b72a0e (diff)
Update docsv0.0.1
-rw-r--r--README.md44
1 files changed, 28 insertions, 16 deletions
diff --git a/README.md b/README.md
index 5fca171..58a7df8 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,32 @@
-# A Realm smart proxy for Foreman
+# A Realm smart proxy for the Foreman
[![Build Status](https://travis-ci.org/theforeman/foreman_ansible_inventory.svg?branch=master)](https://travis-ci.org/theforeman/foreman_ansible_inventory)
-A simple smart proxy that creates LDAP entries on host creation and removes
-them on destroy. It uses Foreman's realm smart proxy API.
+ldapsp is a simple smart proxy for the [Foreman][] that creates LDAP
+entries on host creation and removes them on destroy. It uses
+Foreman's realm [smart proxy API][].
-## Configuration in Foreman
+## Running
+To run in development mode use
+
+ make shell
+
+The proxy will then listen on port 8080. You can check this like
+
+ $ curl http://localhost:8080/features
+ ["realm"]
-Add the smart proxy via the GUI. Foreman will detect the *realm* feature.
+See *tests/test.sh* for more usage examples. To build releases,
+etc. check the [rebar3][] documentation.
+
+## Configuration in the Foreman
+Add the smart proxy via Foreman Web-GUI (Infrastructure → Smart
+Proxies → New Smart Proxy). Foreman will detect the *realm* feature.
## Configuration of ldapsp
-*ldapsp.config* has the ldap connection parameters while *policy.erl*
-determines how the ldap entries will look like. The default policy creates
-entries of the form:
+*priv/ldapsp.config* has the ldap connection parameters while
+*priv/policy.erl* determines how the created ldap entries will look
+like. The default policy creates entries of the form:
dn: cn=<hostname>, dc=example, dc=com
objectclass: top
@@ -20,14 +34,12 @@ entries of the form:
cn: <hostname>
uniqueMember: cn=<hostname>, dc=example, dc=com
-You can replace the module with whatever erlang module you like as long as
-implements add_host/3 and del_host/2.
-
-## Running
-To run in development mode use
-
- make shell
+You can replace the module with whatever [Erlang][] module you like as
+long as it implements *add_host/3* and *del_host/2*.
-To build releases, etc. check the [rebar3][] documentation.
+For SSL it's simplest to put e.g. apache in front of it.
+[Foreman]: https://theforeman.org/
[rebar3]: https://www.rebar3.org/v3.0/docs
+[smart proxy API]: http://projects.theforeman.org/projects/smart-proxy/wiki/API
+[Erlang]: https://www.erlang.org/