JAdmin

From CMS Fruit Wiki
Jump to: navigation, search

This section contains helpful information on how to setup and use JAdmin!

Contents

About JAdmin!

JAdmin! is a high performance Joomla! website administration software. It has a very light footprint on memory and hardware usage. The entire software suite consists of a Joomla! component, plugin and desktop application. This feature filled software suite allows you to be able to manage and monitor your website directly from your desktop. There are many powerful features that JAdmin! offers which include but are not limited to: Real-time Website Activity Monitoring (with visitor geo-location), IP Blocker (to block IP Addresses), Login as user (Login as any registered user to the frontend of your website), and more... With JAdmin!, you can conveniently manage and monitor all your Joomla! websites using one desktop application.

JAdmin! works on all operating systems and platforms including but not limited to Windows, Mac, and Linux. The JAdmin! Joomla! component, and plugin are all open-source and fully customizable using PHP, CSS, and/or HTML.

System Requirements

Website/Webserver System Requirements

  • Joomla! 1.5.x or greater.
  • PHP 4 or greater with cURL support enabled.

Desktop Application System Requirements

  • Compatible with: Windows XP, Windows Vista, Windows 7, Mac OS X 10.5+ (Intel or PowerPC), Ubuntu, Fedora, CentOS, Debian, and any other Linux distribution capable of running Python 2.5 or greater.
  • At least 100MB of free hard disk space.
  • A steady Internet connection. (preferably high speed)

Installing on Joomla! 1.5.x

  1. First download the JAdmin! Joomla component and plugin from our download section for Joomla 1.5. Be sure to download the version for Joomla 1.5 by selecting Download For Joomla 1.5 on the download page since the default version selected is for Joomla 1.6 and higher.
  2. Next install the JAdmin! component and plugin you downloaded in Step 1 onto your website by going to Extensions -> Install/Uninstall from within your Joomla! administrator.
  3. Once you have successfully installed the JAdmin! component and plugin onto your website, then you should install the JAdmin! desktop application onto your computer which is available for download from our download section.
  4. Next you should download your admin access key file by going to Components -> JAdmin! -> Users from within your Joomla administrator. If an admin record does not already exist or you have not created one yet, then you will need to create one by clicking on the New icon on the top right of your Joomla administration screen while on the user management page.
  5. Next add your admin access key file to the JAdmin! desktop app by going to File -> My Websites from within the desktop app main menu.
  6. Congratulations, you're all done setting up JAdmin! :)

Installing on Joomla! 1.6+ or greater

  1. First download the JAdmin! Joomla component and plugin from our download section.
  2. Next install the JAdmin! component and plugin you downloaded in Step 1 onto your website by going to Extensions -> Install/Uninstall from within your Joomla! administrator.
  3. Once you have successfully installed the JAdmin! component and plugin onto your website, then you should install the JAdmin! desktop application onto your computer which is available for download from our download section.
  4. Next you should download your admin access key file by going to Components -> JAdmin! -> Users from within your Joomla administrator. If an admin record does not already exist or you have not created one yet, then you will need to create one by clicking on the New icon on the top right of your Joomla administration screen while on the user management page.
  5. Next add your admin access key file to the JAdmin! desktop app by going to File -> My Websites from within the desktop app main menu.
  6. Congratulations, you're all done setting up JAdmin! :)

Installing Extension via FTP

In some cases, some users may run into permission issues when trying to install the JAdmin! component and plugin onto their website using the Joomla administrator. The work-around for those users is to install the component and plugin onto their website via FTP by following these steps:

  1. Download the component and plugin installation ZIP files onto your computer.
  2. Unzip the component and plugin onto your PC.
  3. Copy unzipped files to tmp folder located in your Joomla! root folder on your website (e.g. create a subfolder there: (Joomla! root) tmp/large-component/
  4. Go to your Joomla! administration -> Extensions -> Extension Manager -> Install from Directory (set the folder where you have copied the files - tmp/large-component/ ) - click on Install.
  5. Perform the above steps for the component, plugin and module. (Each one needs to be installed separately)
  6. After that the extension should be installed successfully :)

Upgrading

      • PLEASE NOTE: BEFORE STARTING THE UPGRADE PROCESS BELOW, it is recommended that you disable your JAdmin! plugin first, BY GOING TO Extensions -> Plugin Manager from within your Joomla administrator and THEN proceeding with the upgrade steps listed below. ***

To upgrade JAdmin! to a newer version, simply uninstall the old JAdmin! component, plugin, and desktop application by going to Extensions -> Install/Uninstall from within your Joomla administrator, and then install the new version.

Please note that by uninstalling the JAdmin! component, plugin and desktop application you will NOT suffer any data loss or loss of preferences. Your data and settings will remain intact on your server and/or computer even after you uninstall the JAdmin! suite.

Uninstalling

To uninstall JAdmin!; you can simply uninstall the JAdmin! component, and plugin by going to Extensions -> Install/Uninstall from within your Joomla administrator. You can also uninstall the JAdmin! desktop application from your computer by going to your control panel -> add remove programs section.

Please note that by uninstalling the JAdmin! component, plugin, module and desktop application you will NOT loss any data or preferences. Your data & preferences will remain intact on your server even after you uninstall JAdmin!.


Force removing the JAdmin! Joomla! component

If for some reason you need to forcefully remove the JAdmin! compoment; you can do so by deleting the following files located within your website's root directory: components/com_jadmin/ components/administrator/com_jadmin/

Then issue the following SQL command on your MySQL database:

 
DELETE FROM jos_components WHERE option = 'com_jadmin';


Force removing the JAdmin! Joomla! plugin

If for some reason you need to forcefully remove the JAdmin! plugin; you can do so by deleting the following files located within your website's root directory: plugins/system/jadmin.php plugins/system/jadmin.xml

Then issue the following SQL command on your MySQL database:

 
DELETE FROM jos_plugins WHERE element = 'jadmin';

Force removing is not recommended because it can leave behind some language translation files located in your /language and /administrator/language directories. In which case you will also need to find all the JAdmin! translation files and delete them as well.

Poll & Push Data Synchronization

Setting Up Data Pusher Cronjob The data pusher cronjob is a worker process that sends out synchronization data out to the admin desktop applications instead of the desktop applications polling data from the webserver. This method is recommended for maximum performance and maximum scalability for the number of admins you have. Users that plan to have a large amount of admins or even more than 10 admins are highly urged to use this data pusher ccronjob method as opposed to the polling method which is also available as an option in JAdmin!. If you decide to use the polling syncer method instead of the data pusher cronjob, then it is recommended you exclude JAdmin! requests from your web log.

Add the following cronjob to your /etc/crontab file located on your webserver. The crontab file located may vary depending on the type of operating system you are running on your webserver.

*/5 *    * * *   www-data    php /var/www/vhosts/yourdomain.com/httpdocs/components/com_jadmin/jadmin.cron.php >/dev/null 2>&1

You will need to replace the path above with your path to the jadmin.cron.php file. You will also need to replace the www-data user with your webserver user, for example apache.

After setting up the data pusher cronjob, it will execute every 5 minutes, however there is a built in mechanism that disallows the data pusher cronjob from running multiple instances at the same time. Technically we don't need to have the cronjob above run every 5 minutes because it is a worker process that continuously runs once launched until it is shutdown, however in this case we recommend running the data pusher cronjob every 5 minutes to simply ensure that it is always running even after a webserver restart and also because it has a built in mechanism that prevents multiple instances from running at the same time, so in this case it would be safe to execute this cronjob every 5 minutes.

Once the data pusher cronjob above is executed and running on your webserver, you can then switch your JAdmin! desktop application in data pusher mode, which automatically disables the JAdmin! desktop application polling mechnism. You can switch your JAdmin! desktop application into data pusher mode by going to File -> My Preferences from within your JAdmin! desktop application and changing the Listen Post preference to 0. Defining 0 (zero) as the listen port will cause the JAdmin! desktop application to listen on 2 random consecutive TCP ports on your computer. This is where the JAdmin! desktop application will receive synchronization data from your webserver (from the data pusher cronjob) for JAdmin!.

Alternatively, for maximum compatiblity, the JAdmin! desktop application runs in poll data mode by default which basically connects to your webserver every few seconds and fetches synchronization data. If you use this method then it is highly recommended to exclude JAdmin! requests from your web log as it may cause webserver performance/hardware degradation.

Excluding Webserver Logging

Excluding logging for JAdmin! requests to your webserver will prevent performance degradation and/or your hard disk filling up if there is no log rotation software installed on your server. This step is not required but is recommended for those users who do not have log rotation software installed on their webserver, or for those who do not have access to change your webserver configuration files, or those who are in a shared hosting environment, we highly recommend using JAdmin! in data pusher mode.

Edit your Joomla! website's .htaccess file, and insert the following 2 lines under "RewriteEngine On", so the end result will look like this:

RewriteEngine On
 
RewriteCond %{QUERY_STRING} do_not_log[=,]true [NC]
RewriteRule ^.*$ - [E=dontlog:1]
RewriteCond %{REQUEST_URI} do_not_log[=,]true [NC]
RewriteRule ^.*$ - [E=dontlog:1]

Then edit your virtual host configuration file, and follow the steps for your platform below.

Apache Webserver Instructions

Edit your virtual host configuration file, which is usually named httpd.conf, or apache2.conf, or <your-site-name>.conf and add "env=!dontlog" to the end of the "CustomLog" attribute, and add "AllowOverride All" or "AllowOverride FileInfo" so that it looks like this:

<VirtualHost www.yourdomain.com:80>
 
          DocumentRoot "/var/www/vhosts/www.yourdomain.com/httpdocs"
          ServerName www.yourdomain.com
 
 
          ......       <-- Some other lines here 
 
          <Directory "/var/www/vhosts/www.yourdomain.com/httpdocs">
 
                    ......       <-- Some other lines here 
 
 
                    # Either AllowOverride FileInfo, or AllowOverride All
                    AllowOverride All 
 
          </Directory>
 
 
          # Add env=!dontlog to the end of the CustomLog Attribute
          CustomLog /var/www/vhosts/www.yourdomain.com/logs/access.log common env=!dontlog
 
 
 
          ......      <-- Some other lines here
 
</VirtualHost>

Save those changes and restart apache.


Plesk Webserver Instructions

Edit /var/www/vhosts/<your-website.com>/conf/httpd.include and add "env=!dontlog" to the end of the "CustomLog" attribute. The end result should look something like this:

<VirtualHost 100.22.22.22:80>
 
          CustomLog /var/www/vhosts/<your-website.com>/statistics/logs/access_log plesklog env=!dontlog

Save those changes and restart apache. You can restart apache by issuing the following command on linux:

/etc/init.d/httpd restart

or

/etc/init.d/apache2 restart

The only drawback on Plesk is that if you change your virtual host's settings through the Plesk Administration site, your changes to the httpd.include file will be overwritten by plesk. One way to work around this is to keep a backup copy of your httpd.include and perhaps name it httpd.good.include. That way if Plesk overwrites your httpd.include file, then you can just copy the correct httpd.good.include over the incorrect httpd.include file.


cPanel Instructions

SSH to your webserver so that you can access your webserver's shell prompt.

Copy your cPanel vhost template file from /var/cpanel/templates/apache2/vhost.default to /var/cpanel/templates/apache2/vhost.local. You can copy this file by executing the following command at the shell prompt:

sudo cp /var/cpanel/templates/apache2/vhost.default /var/cpanel/templates/apache2/vhost.local

Edit the new /var/cpanel/templates/apache2/vhost.local file you created above and add env=!dontlog to the end of the "CustomLog" attribute. The final resulting file should look something like this:

<VirtualHost 100.22.22.22:80>
 
          CustomLog /usr/local/apache/domlogs/mydomain.me combined env=!dontlog

If you also want to exclude JAdmin! requests from HTTPS requests, then repeat the step above, but this time by copying the file /var/cpanel/templates/apache2/ssl_vhost.default to /var/cpanel/templates/apache2/ssl_vhost.local. Otherwise you can skip this step.

Now rebuild your vhost conf files by running the following command:

sudo /scripts/rebuildhttpdconf

Now reload your apache webserver for the changes to take effect by running the following command:

/etc/init.d/httpd restart

or

/etc/init.d/apache2 restart

For further information on customizing your cPanel configuration files, please visit: http://docs.cpanel.net/twiki/bin/view/EasyApache3/InsideVHost#Custom%20templates%20that%20will%20apply

Custom Branding

Hiding CMS Fruit Menu Items and Disabling Splash Image

The CMS Fruit related menu items and splash image on the JAdmin! desktop application can be hidden for cases where users want to custom brand the JAdmin! desktop application, simply by creating a file named custom.lock and placing it in the JAdmin! installation directory (where the jadmin.exe file is located)

For example, one might create an empty custom.lock file in the following path on their system: c:\Program Files\CMS Fruit\JAdmin\custom.lock

You can also bundle your new custom.lock file with a new JAdmin! installer by adding your custom.lock file to the installer.nsi file located in your JAdmin! installation directory, and then recompiling the installer.nsi file using Nullsoft Scriptable Install System (NSIS).


Creating a Custom JAdmin! Installer Package (JAdmin_Setup.exe)

You can create your own custom JAdmin_Setup.exe installer package for windows by recompiling the installer.nsi file that was bundled with JAdmin!, usually located in your JAdmin! installation directory:

c:\Program Files\CMS Fruit\JAdmin\installer.nsi

Using JAdmin! Mobile

  1. Download & launch the JAdmin! mobile app by visiting the app store from your mobile device.
  2. Then proceed to define your website by going to the - Define a website - section on the main screen of the mobile app, and enter your Website Domain/Install Path and User Access Key Code. Your Website Domain/Install Path should be the path to your website where you installed the JAdmin! component, and plugin. For example, if your website is at http://www.mywebsite.com, then you would enter www.mywebsite.com as your Website Domain/Install Path setting and if your website is located at http://www.mywebsite.com/myjoomlasite/ then you would enter www.mywebsite.com/myjoomlasite/ as your Website Domain/Install Path setting. Your User Access Key Code can be found by going to Components -> JAdmin! -> Users from within your Joomla administrator.


Please note that the mobile app is very picky about the Website Domain/Install Path setting when used in conjuction with SSL/HTTPS. It is very important that the value you enter as your Website Domain/Install Path is the full registered domain that matches your SSL certificate. For example, if you enable SSL/HTTPS use with JAdmin! mobile and your website is located at www.mywebsite.com and you enter mywebsite.com as your Website Domain/Install Path, then it will not work. It will say that you have entered an invalid operator access key code or it cannot be authenticated.

Troubleshooting

If you experience any problems with JAdmin!, you can always perform a system check by going to Components -> JAdmin! -> Information from within your Joomla administrator to check for any problems with your installation.

Your Joomla! Administrator is usually located @ http://<your-site>/administrator

If you have any further questions or support issues, please submit a debug report by going to Help -> Debug Repot -> Send to Technical Support from within the JAdmin! desktop application and then contact us by submitting a support ticket.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox