wordpress plugin, RT#75279
[freeside.git] / fs_selfservice / wordpress / README.txt
1 Freeside signup and self-service plugin for Wordpress
2
3
4 Installation:
5
6 Copy this directory to your Wordpress plugins directory
7 (For example, /var/lib/wordpress/wp-content/plugins/freeside/)
8
9 Make sure the PHP XMLRPC module is installed
10 (for example, "apt-get install php-xmlrpc")
11
12
13 Activation:
14
15 In Wordpress, go to Plugins -> Installed Plugins, find the "Freeside signup and
16 self-service" plugin, and click "Activate".
17
18
19 Configuration:
20
21 In Wordpress, go to Settings -> General and set "Freeside self-service URL"
22 to the 
23
24
25 Freeside configuration:
26
27 Go to Configuration -> Settings and turn on "selfservice-xmlrpc".  Restart
28 Freeside services to turn on the daemon ("etc/init.d/freeside restart", or
29 "service freeside restart")
30
31
32 Firewall/network configuration:
33
34 Allow the Wordpress machine to connect to port 8080 on the Freeside machine.
35 Ensure the connection is on a secure network, or appropriately secured with a
36 VPN or tunnel.
37
38
39 Usage:
40
41 See the included example_login.php, process_login.php and
42 example_selfservice.php files.  These files perform a self-service login
43 and display a basic landing page.  To use, copy them to the wordpress content
44 directory (or a subdirectory), and point your browser to example_login.php
45
46 For full API documentation including all available functions, their arguments
47 and return data, see
48 http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Developer/FS/SelfService
49