Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 81 lines (51 sloc) 2.616 kb
9f252f9 @pgodel Added documentation and license
pgodel authored
1 What is ServerGroveLiveChat?
2 ----------------------------
3
4 ServerGroveLiveChat is a PHP 5.3 Symfony 2 application that allows website visitors to engage in a web-based chat
5 with operators of a website. It allows a company to offer live chat support.
6
7 Requirements
8 ------------
9
10 * PHP 5.3.2 or newer
11 * PHP mongo extension
12 * MongDB database server
13 * jQuery in your website to integrate the livechat button/tracker
14
15 Installation
16 ------------
17
18 1. Download application package or [clone the repository](https://github.com/servergrove/ServerGroveLiveChat)
19
20 2. Setup a virtual host (optional) and restart web server
21
22 <VirtualHost *:80>
23 DocumentRoot /usr/local/ServerGroveLiveChat/web
24 ServerName livechat.example.com
25 ErrorLog "logs/livechat-error_log"
26 CustomLog "logs/livechat-access_log" combined
27 <Directory /usr/local/ServerGroveLiveChat/web>
28 AllowOverride All
29 </Directory>
30 </VirtualHost>
31
32 3. Make sure web server can write to app/cache and app/logs, ie.:
33
9cf7985 @pgodel formatting fixes
pgodel authored
34 chmod -R 777 app/cache app/logs
9f252f9 @pgodel Added documentation and license
pgodel authored
35
36 4. Configure MongoDB connection, by default it will connect with localhost, you can change it by editing app/config/config.yml
37
9cf7985 @pgodel formatting fixes
pgodel authored
38 doctrine_odm.mongodb:
39 server: mongodb://localhost:27017
9f252f9 @pgodel Added documentation and license
pgodel authored
40
91f6665 @pgodel formatting fixes
pgodel authored
41
42 5. Configure the livechat caching engine. The application uses a caching engine to store chat status information. By default it will use APC, but you can also use mongo. You can configure it like this in app/config/config.yml:
9f252f9 @pgodel Added documentation and license
pgodel authored
43
9cf7985 @pgodel formatting fixes
pgodel authored
44 sglivechat.config:
45 cache_engine: mongo
9f252f9 @pgodel Added documentation and license
pgodel authored
46
91f6665 @pgodel formatting fixes
pgodel authored
47
9f252f9 @pgodel Added documentation and license
pgodel authored
48 6. Add a livechat administrator
49
0662b37 @pgodel formatting fixes
pgodel authored
50 ./app/console sglivechat:admin:add-administrator "Your Name" email@example.com password1234
9f252f9 @pgodel Added documentation and license
pgodel authored
51
52 7. Launch launch administration interface and login with the administration information entered in step 6
53
0662b37 @pgodel formatting fixes
pgodel authored
54 http://livechat.example.com/admin/sglivechat
9f252f9 @pgodel Added documentation and license
pgodel authored
55
56 8. Add the livechat button and status indicator to your website:
57
82b7325 @pgodel formatting fixes
pgodel authored
58 In `<head>`:
f843f0a @pgodel formatting fixes
pgodel authored
59 <script src="http://livechat.example.com/js/jquery.js"></script>
9f252f9 @pgodel Added documentation and license
pgodel authored
60
61 In the location where you want the livechat button to appear:
f843f0a @pgodel formatting fixes
pgodel authored
62 <script src="http://livechat.example.com/js/sglivechat-tracker/status.js"></script>
9f252f9 @pgodel Added documentation and license
pgodel authored
63
64 9. You can also test the livechat functionality by loading:
65
66 http://livechat.example.com/test.html
67
68 Contributing
69 ------------
70
71 We encourage people to participate and contribute to the project. Feel free to clone the git repository and send us pull requests.
72 Please contact us before starting a new feature to make sure there is no effort duplication.
73
74 Todo
75 ----
76
77 * Integration with Jabber for new chats alerts
78 * Additional documentation
79 * Bug fixes
80
Something went wrong with that request. Please try again.