default to a session cookie instead of setting an explicit timeout, weird timezone...
[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 server"
22 to your Freeside server name or IP address.
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 Freeside self-service:
33
34 If you are using signup or additional package order with the API-provided
35 package selection HTML (as in the services_new.php example), make sure the
36 regular Freeside self-service is installed on the same server as the wordpress
37 site.  Make sure the Freeside configuration setting
38 "selfservice_server-base_url" is correct and matches the hostname used to
39 access the site, including https:// if using (which you certainly should!).
40
41
42 Firewall/network configuration:
43
44 Allow the Wordpress machine to connect to port 8080 on the Freeside machine.
45 Ensure the connection is on a secure network, or appropriately secured with a
46 VPN or tunnel.
47
48
49 Usage:
50
51 See the included example_login.php, process_login.php, process_login.php,
52 example_selfservice.php and view_invoice.php files.  These files perform a
53 self-service login and display a basic landing page.  To use, copy them and
54 the elements/ subdirectory to the wordpress content directory (or a
55 subdirectory) and point your browser to example_login.php
56
57 For full API documentation including all available functions, their arguments
58 and return data, see
59 http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Developer/FS/SelfService
60