This acts as a server to the AtomJump Loop open source interface at http://github.com/atomjump/loop
PHP 5, fully tested on PHP 5.3 and 5.5 (with Curl added),
MySQL 5+,
Apache2,
Linux server (though a Windows server may be partially functional)
Modify upload size in php.ini (usually /etc/php5/apache2/php.ini)
upload_max_filesize = 10M
max_execution_time = 200
service apache2 reload
Imagemagick can be used (Ubuntu command):
sudo apt-get install imagemagick
To keep timing in-sync (Ubuntu command):
sudo apt-get install ntp
Amazon MySQL RDS (any number of db servers),
Load balancers with haproxy,
SSL server
-
/server directory. Replace atomjump with your own domain, and put any relevant files into your Apache 'sites available' setup. You may need to restart Apache.
-
/config/configORIGINAL.json. Copy to config/config.json. Replace the options with your own accounts and paths.
-
Create a temporary image upload directory at /images/im
chmod 777 /images/im
-
Copy SET_AS_htaccess to .htaccess and replace atomjump.com with your domain
-
Customer defined themes must be on a secure server if the server is on ssl.
-
To the ajFeedback object in your index.html, add a parameter
"server": "http://yourserver.com"
- In a MySQL prompt, run 'create database ssshout'. Then from the command line:
mysql -u youruser -p ssshout < db/atomjump-loop-shell.sql
Currently using an old style mysql php connection. We will try to update this when possible.
Add two cron tasks to your server:
- A typing cleanup task. On rare instances, a 'typing...' message is left (if the machine cut out etc.). This cleans up any of these old messages periodically (every 5 minutes).
sudo crontab -e
*/5 * * * * /usr/bin/php /yourserverpath/typing-cron.php
- A sentiment analysis task. This sentiment is reflected when you download a spreadsheet of the messages. It requires nodejs to be installed and available to be run by a cron job.
On your internet server, first install NodeJS and npm. See Ubuntu install notes at https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-an-ubuntu-14-04-server, but there are several ways to do this depending on your platform e.g. MacOSX may vary slightly.
cd /yourserverpath/node
npm install
sudo crontab -e
*/1 * * * * /usr/bin/nodejs /yourserverpath/node/sentiment.js -production
This will update the production database message sentiments once every minute (or remove the -production to go to staging).
This tool provides a 'WhatsApp-like' group discussion forum from a popup on your website. It is good for feedback, but can also be used as a live discussion tool, or a CRM. We actually run our entire operation off one page with several of these popups on it.
The client software is entirely Javascript and CSS, but it refers to an AtomJump Loop server to store messages. Supported client platforms: IE8 upwards, Chrome, Firefox, Safari, Android Native, Android Chrome, Android Firefox, iPad, iPhone, Opera. There may be other supported platforms we haven't tested on.
See the demo at AtomJump
You are most welcome to adjust the styling by making changes to the CSS file for your project.
With bower from within the root of your project path:
bower install atomjump
(Or without bower, unpack into your project, edit index.html, and replace bootstrap css and javascript paths as mentioned)
Run atomjump/index.html in your browser. You should see a 'Click me for comments' link. Click this to see the pop-up.
Look carefully at the index.html example.
The code between
<!-- AtomJump Feedback Starts -->
and
<!-- AtomJump Feedback Ends -->
should be put into your page's <head> section.
Links can be added to the comments with
<a class="comment-open" href="javascript:">Click me for comments</a>
The code
<div id="comment-holder"></div>
must be placed anywhere in the <body> section.
Note: jQuery ver 1.9.1 is used. Other jQuery versions will likely work also.
-
Adjust 'uniqueFeedbackId' value to a unique value to suit your feedback. This can be unique per page or the same throughout the whole site.
-
Obtain the 'myMachineUser' value by following the sub-steps below:
- Settings
- Entering an email/Password
- Click save
- Settings
- Clicking: 'Your password', then 'Advanced'
- Copy the myMachineUser into the myMachineUser value in your html file.
This ensures only you as a logged in user will receive feedback from your site.
- If you wish to, you can enter your mobile phone number under Settings to receive SMS messages when there is any feedback (at a cost of 16c per message. Messages within 5 minutes of each other do not trigger an SMS). If you want to include an sms modify the myMachineUser string on your page to include the 3rd term 'sms' e.g. "123.456.123.32:1200:sms". If you don't include an 'sms', you won't receive sms messages.
If you wish to send SMS messages, we will keep track of messages sent, and charge independently based on usage, on a monthly basis.
Add the following data tags, and enter your own names/ips:
<a class="comment-open" data-uniquefeedbackid="my_different_forum_name" data-mymachineuser="10.12.13.14:2" href="javascript:">Open special forum</a>
Open the messaging forum in your browser.
- Settings
- Entering an email/Password
- Click save
- Settings
- Clicking: 'Your password', then 'Advanced'
- Edit the 'This forum's private owners' and put in each myMachineUser separated by a comma. 'sms' can be added individually to each user to optionally send an sms also.
e.g. "123.456.123.32:1200:sms,123.456.123.32:1201:sms"
Add
"cssBootstrap":"relative/url"
and
"cssFeedback":"relative/url/to/your/css"
to the ajFeedback object.
Note: your css file must be on an https server, if your server is using https.
Endpoint http://yourserver.com/download.php
Parameters
- email Your AtomJump Loop email address from the standard interface
- pass
Your AtomJump Loop password - uniqueFeedbackId
The particular forum to view. - from_id
There is a limit of 2000 records per request. To download more, include the 'id' of the last record, from the previous download request, in this field.
Which returns a JSON object. Included for reporting is a 'sentiment' field which measures how positive the comment is (< 0 negative, 0= neutral, > 0 positive).
Include the following parameters along with 1,2, and 3 above.
-
format
Set to 'avg'
-
duration
Period over which to average in seconds.
The response will be an average over the last period of all the message sentiment values. This will be expressed as a single number eg. 5.324. Note: it can take up to 1 minute before any new message's sentiment will be calculated.
For more details see https://atomjump.com
Production: The port 1444 code is only used in a production install, and you must have configured haproxy. This is mapped inside the haproxy config back to port 80 for a normal http request.
Staging: To ensure you are set to staging, set the 'webDomain' param in the config.json to the raw local domain or hostname actually used. E.g. an ip address would be '192.168.40.10' or a domain would be 'subdomain.yourdomain.com'. If you change from an ip to a domain, ensure you switch over this param at the time of the switchover, because the server defaults to production. A staging server does not need haproxy to be configured.
To test the web domain, use the following small PHP script:
db hosts: there can be any number of db hosts, but the first one is the only write host, while the others are read. We use Amazon MySQL RDS for multiple db hosts.
ips: any number of PHP machines with the server software on it.
webRoot: Web path including http/https of the server. Don't include trailing slash.
fileRoot: Local file system server's file path. Don't include trailing slash.
serverTimezone: Change this to the location of the physical server eg. Pacific/Auckland
loadbalancer: Required for a production setup - any number of machines. Can be blank in a staging setup.
phpPath: Path to externally run any parallel PHP processes. Ver >= 0.5.5
logoutPort: Port which a logout is supported on. Default 1444. Use in an ssh situation, whereby this is a non-ssh port. Ver >= 0.5.5
adminMachineUser: once your server has been set up, and you have saved your first user (yourself typically), find this user in the interface Advanced settings, and write this into the config. This is the default location for private messages if there is no other owner of a group.
mailgun: optional. If you do not want emails being sent off, you can leave this off. You need a mailgun account otherwise which has about 10,000 free emails per month, but costs after that.
amazonAWS: optional. Currently required for image uploads. This is for S3 storage of uploaded images.
USDollarsPerSMS: for reporting purposes only. This is what is shown to users if they choose to use the SMS notifications. Since there is a cost to you for each SMS, you will likely set this slightly higher than the actual cost of an SMS, to account for fluctuations in price.
twilioSMS: optional. Required for sending off SMSes.
piwik: optional. Only needed for retrieving unique backgrounds for subdomains of atomjump.
twitter: optional. Retrieves tweets from twitter related to this subdomain, and allows for replying to the tweets (posts a message via twitter).
Plugins can be installed in the /plugins directory. See https://atomjump.com/smart.php for a list of plugins available.
For a sample plugin called 'hide_aargh':
/plugins/hide_aargh/index.php
<?php
include_once("classes/cls.pluginapi.php");
class plugin_hide_aargh
{
public function on_message($message_forum_name, $message, $message_id, $sender_id, $recipient_id, $sender_name, $sender_email, $sender_phone)
{
//Do your thing in here. Here is a sample.
$api = new cls_plugin_api();
//e.g. hide the message we have just posted if it includes the string 'aargh' in it.
if(strpos($message, 'aargh') !== false) {
$api->hide_message($message_id);
}
return true;
}
}
?>
Add the entry "hide_aargh" to the "plugins" array in config/config.json to activate the plugin.
db_insert()
Parameters
($table, $insert_field_names_str, $insert_field_data_str)
Server: >= 0.5.0
db_select()
Parameters
($sql)
Server: >= 0.5.0
db_update()
Parameters
($table, $update_set)
Server: >= 0.5.0
get_forum_id()
Parameters
($message_forum_name)
Server: >= 0.5.0
get_current_user_ip()
No parameters
Server: > 0.5.0
get_current_user_id()
No parameters
Server: >= 0.5.0
on_message()
Output parameters
($message_forum_id, $message, $message_id, $sender_id, $recipient_id, $sender_name, $sender_email, $sender_phone)
Plugin function returns
(true)
Server: >= 0.5.1
before_message()
Output parameters
($message)
Plugin function returns
($message)
Server: >= 0.5.0
on_more_settings()
Output parameters
($message)
Plugin function writes HTML inside ordinary PHP tags e.g. ?>Your settings HTML<?php
Server: >= 0.5.9
on_save_settings()
Output parameters
($user_id, $full_request: array of options, $type: NEW or SAVE)
Plugin function returns
(true/false)
on_upload_screen()
Output parameters
($message)
Plugin function writes HTML inside ordinary PHP tags e.g. ?>Your settings HTML<?php
Server: >= 0.5.9
new_message()
Required Parameters
($sender_name_str, $message, $recipient_ip_colon_id, $sender_email, $sender_ip, $message_forum_name, $options)
Server: >= 0.5.0
Optional Parameters in an $options object:
($sender_still_typing, $known_message_id, $sender_phone, $javascript_client_msg_id, $forum_owner_id, $social_post_short_code, $social_recipient_handle_str, $date_override, $latitude, $longitude, $login_as, $allow_plugins, $allowed_plugins)
Server: >= 0.5.0
Additions:
($login_as), server >= 0.5.1
($allow_plugins, $allowed_plugins), server >= 0.55
Output parameters ($message_id)
hide_message()
Required Parameters
($message_id)
Server: >= 0.5.0
Optional Parameters
($warn_admin)
Server: >= 0.5.0
parallel_system_call()
Required Parameters
($command)
Server: >= 0.5.5
Optional Parameters ($platform:'linux'/'windows' default:'linux')
Contributions are welcome, and they can take the shape of:
- Core: Submit github pull requests. We will need to consider whether the feature should be in core, or externally as a plugin. It is generally a good idea to get in touch with us via our homepage at https://atomjump.com to ensure we are not already working on a similar feature.
- Plugins: Develop to the API above, and then publish on the https://atomjump.com/smart.php 'available plugins' link. You are free to write or publish (or keep private) any number of plugins.
- Translations: We are looking for any translations of the conf/messages.json file from English into your language. We have machine translated Spanish as a first step, but we need help in ensuring this is a good translation, and applying other languages.