summaryrefslogtreecommitdiff
path: root/fs_selfservice/wordpress/README.txt
blob: 47c381deb680cb2c5849100cb2a70511ec0d07f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Freeside signup and self-service plugin for Wordpress


Installation:

Copy this directory to your Wordpress plugins directory
(For example, /var/lib/wordpress/wp-content/plugins/freeside/)

Make sure the PHP XMLRPC module is installed
(for example, "apt-get install php-xmlrpc")


Activation:

In Wordpress, go to Plugins -> Installed Plugins, find the "Freeside signup and
self-service" plugin, and click "Activate".


Configuration:

In Wordpress, go to Settings -> General and set "Freeside server"
to your Freeside server name or IP address.


Freeside configuration:

Go to Configuration -> Settings and turn on "selfservice-xmlrpc".  Restart
Freeside services to turn on the daemon ("etc/init.d/freeside restart", or
"service freeside restart")


Freeside self-service:

If you are using signup or additional package order with the API-provided
package selection HTML (as in the services_new.php example), make sure the
regular Freeside self-service is installed on the same server as the wordpress
site.  Make sure the Freeside configuration setting
"selfservice_server-base_url" is correct and matches the hostname used to
access the site, including https:// if using (which you certainly should!).


Firewall/network configuration:

Allow the Wordpress machine to connect to port 8080 on the Freeside machine.
Ensure the connection is on a secure network, or appropriately secured with a
VPN or tunnel.


Usage:

See the included example_login.php, process_login.php, process_login.php,
example_selfservice.php and view_invoice.php files.  These files perform a
self-service login and display a basic landing page.  To use, copy them and
the elements/ subdirectory to the wordpress content directory (or a
subdirectory) and point your browser to example_login.php

For full API documentation including all available functions, their arguments
and return data, see
http://www.freeside.biz/mediawiki/index.php/Freeside:3:Documentation:Developer/FS/SelfService