add integration with rules
[project/webid.git] / INSTALL.txt
1 PREREQUISITES
2 -------------
3 * Before using the WebIdauth module, please make sure you have a working installation of an 
4 authentication service, like the one at https://auth.fcns.eu/auth/index.php
5 To setup the service, you will need to create an SSL - enabled virtual host on your server 
6 configuration and enable client certificate handling. To get WebIDauth service up and running, 
7 you will also need the public - private key pair of your WebID auth server. The private key path 
8 should be accessible from WebIDauth service and configured in its index.php.  For further 
9 information, review the documentation in https://github.com/WebIDauth/WebIDauth
10
11 * Make sure you have the Libraries API (http://drupal.org/project/libraries) module installed 
12 and have downloaded the following libraries:
13
14 1. libAuthentication (WebIDauth fork: https://github.com/WebIDauth/libAuthentication)
15 2. ARC2 library (https://github.com/semsol/arc2/)
16 3. Graphite RDF library (http://graphite.ecs.soton.ac.uk/)
17
18 and installed them in the /sites/all/libraries directory. The path to libAuthentication's config
19 .php should be /sites/all/libraries/libAuthentication/config.php , while the path to ARC's ARC2
20 .php should be sites/all/libraries/ARC2/arc/ARC2.php , per the rdfx module recommendation. 
21 The path to
22 graphite's  Graphite.php should be sites/all/libraries/Graphite/Graphite.php
23
24 Please configure lib/Authentication_X509CertRepo.php to match your certificate pair, by 
25 entering your public key.
26
27 INSTALLATION
28 ------------
29 1. Download and install the module from drupal.org, using the Modules administration panel, or 
30 any other preferred way
31 2. Enable the module in Modules administration panel
32 3. Set the authentication service URL in admin/config/people/webidauth
33
34 Now you should be able to associate users with WebID's and register with a WebID, as described
35 in the README.txt