NuSEO.PHP - Installation Instructions

NuSEO.PHP - Installation Instructions

NuSEO.PHP Installation Requirements

  • PHP version 4.3 or greater
  • PHP safe_mode set to Off
  • If your NuSEO.PHP license is not NuSEO.PHP Standard + Source Code, NuSEO.PHP Professional + Source Code or NuSEO.PHP Enterprise, then IonCube loaders must be installed and functioning. For more information please visit http://www.ioncube.com/loaders.php
  • If NuSEO.PHP's log is enabled and the log storage is set to Database, then MySQL Server 4.1 or greater is required..
  • To access NuSEO.PHP Admin CP, it is recommended to use FireFox 2.0+ or IE 6+, although any javascript enabled browser is supported.

Installing NuSEO.PHP

It is strongly recommended to install NuSEO.PHP in a Test or Development Server with a copy of your site and Database before installing NuSEO.PHP in your public server.

If your NuSEO.PHP license is NuSEO.PHP Standard or NuSEO.PHP Professional (without Source Code) then IonCube loaders must be installed and operating on the server before NuSEO.PHP is installed.

1. Extracting the installation package

Download and extract the installation package into a directory in your local computer.

2. Uploading NuSEO.PHP to the Server.

Follow the instructions corresponding to your NuSEO.PHP license type.

  1. NuSEO.PHP Standard and NuSEO.PHP Professional can be uploaded either manually using an FTP Client or using the Automated Windows Installer.
    • Automated Windows Installer. Launch NuSEO.PHP's Automated Installer for Windows: find and run the file named nuseo_installer.exe. Follow the onscreen wizard to install NuSEO.PHP. The Automated Installer will perform these actions:
      • Create the appropriate directories in the server.
      • Upload NuSEO.PHP's files to your Web Server through FTP.
      • Set appropriate file and directory permissions.
    • Uploading Files Manually
      • FTP Client Upload. Using an FTP Client upload the directory named nuseo found in the installation package to your server root (for instance, if your server root is public_html, then nuseo will be installed in public_html/nuseo). It is important to set the transfer mode to 'Binary' before uploading the files.
      • Changing file and directory permissions.. Using an FTP Client make the following directories and files writable (set permissions to 0777): nuseo/logs and nuseo/nuseo_config.php-dist.
  2. NuSEO.PHP Standard + Source, NuSEO.PHP Professional + Source and NuSEO.PHP Enterprise.
    • FTP Client Upload. Using an FTP Client upload the directory named nuseo found in the installation package to your server root (for instance, if your server root is public_html, then nuseo will be installed in public_html/nuseo).
    • Changing file and directory permissions.. Using an FTP Client make the following directories and files writeable (set permissions to 0777): nuseo/logs and nuseo/nuseo_config.php-dist.

3. Activating NuSEO.PHP

Log into NuSEO.PHP Admin CP (located at http://www.yourdomain.com/nuseo/admin/), enter and save your License Number. The License Number can be entered in the Settings Tab > Core Settings.

4. Enabling NuSEO.PHP Modules

In NuSEO.PHP's Admin CP, go to the Modules Tab and enable and configure the modules you have installed on your site. If you'd like you can enable one module, configure it, test it, and then move to the next and so on. (Most modules require that the path where the corresponding software is installed be specified in a setting named 'URL Base'. For instance if your forum is found at www.yourdomain.com/forums, then vBulletin's URL Base is /forums. Verify that these settings are correct.

5. Configuring NuSEO.PHP.

Review the settings for NuSEO.PHP's Core Engine (Settings Tab), and for all modules you have enabled (Modules Tab). These settings include the format to be used for your site's URLs. It is important to review these settings carefully. After installing and enabling NuSEO.PHP, Search Engines will update their links to your site to include the new Search Engine Friendly URLs, after this takes place, changing the URL Format Settings at a later time may cause '404 - page not found' errors.

6. Uploading the .htaccess file

If your server does not have a .htaccess file in its root, then upload the .htaccess file found in the docs directory in the installation package. If your Operating System has trouble dealing with the .htaccess file, upload htaccess.txt instead, and then rename it to .htaccess once in the server.

If your server already has a .htaccess file in its root, then the content of NuSEO.PHP's .htaccess will have to be merged into the main .htaccess file. Contact support if you have any questions.

NuSEO.PHP's .htaccess file contains a number of rules that should be uncommented only when needed.

  • Older versions of Apache may require that the rule named "NuSEO.PHP Directory Index Rules (for Apache 1.x and 2.0)" be uncommented.
  • Some phpFox add-ons may add directories in phpFox's installation home, for these the rule named "NuSEO.PHP phpFox Add-on Rules (e.g. Arcade, Video, etc)" should be uncommented and adjusted appropriately. Contact NuHIT Support if you have any questions.

7. Per-Module Extra Steps

Depending on the NuSEO.PHP Modules you have enabled, some extra steps may be required. If you have enabled any of the following modules, follow the corresponding instructions.

  • phpFox.
    • In your phpFox installation, find and edit a file named include/settings/server.sett.php.
    • In this file find these settings and change their value to the following: 
          $_CONF['rewrite_engine'] = false; 
    $_CONF['path_translated'] = false;
    • If phpFox is installed in a subdirectory, rename phpFox's .htaccess, if any.
    • If phpFox is installed in your site's root directory, rename it, and follow the steps outlined in 'Uploading the .htaccess file' are followed.
    • NuSEO.PHP will work out of the box with most phpFox plugins and add-ons. If you have a plugin that is not working as it should after installing NuSEO.PHP, please contact support.
  • vBulletin.
    • Go into vBulletin's Admin CP > Plugins & Products > Manage Products. Click on 'Import Product' and select 'overwrite'
    • Click on the 'Browse' button, and browse to the location where NuSEO.PHP's installation package was extracted. Find a file named product_nuseo_vbulletin.xml, in the directory nuseo\modules.
    • Click on 'Import'
    • After the product XML has been imported, a new command will be visible on the left-hand navigation bar, named 'Reset NuSEO.PHP Forum Slugs'. It is important to execute this command whenever you change the format of the URLs for your forums.
  • ZenCart.
    • Log into your ZenCart store's Admin
    • In the Configuration Menu, Select GZip Compression
    • Set 'Enable GZip Compression' to 0 (off)

8. NuSEO.PHP Enterprise High Traffic Optimizer

  • Test NuSEO.PHP Installation with HTO disabled first. If your license includes NuSEO.PHP High Traffic Optimizer (HTO), complete the installation instructions outlined above before enabling the HTO.
  • Enable NuSEO.PHP High Traffic Optimizer. In NuSEO.PHP's Admin CP > Core Settings > High Traffic Optimizer, select the accelerator software your site is using (E.g. Memcached, XCache, APC, eAccelerator) and enable the HTO. The corresponding PHP Extension should be previously installed and enabled in your server(s).
  • If using Memcached, configure NuSEO.PHP's Memcached Settigns. In NuSEO.PHP's Admin CP > Core Settings > Memcached Settings, enter the memcached servers IP addresses and port number (one per line, for multiple servers). Example: 
        127.0.0.1:11211
    10.0.0.16:11211
  • Fine-tuning HTO. You can control how much memory NuSEO.PHP's HTO uses by adjusting the value of the "Cache Timeout" setting. This setting contains the number of seconds NuSEO.PHP will keep an object cached in-memory (either in the local or external, depending on the cache system used). Objects can be URL Request Translations, Anchor rewriting, among other data.
  • Changing URL Format Settings after HTO has been enabled. Since NuSEO.PHP's caches URLs in-memory, when changing the URL Formats, you should flush your in-memory cache system (e.g. from XCache's Admin page), if the cache system doesn't support this functionality, you can restart your cache server, if any. Alternatively, you can turn off NuSEO.PHP's HTO for the same number of seconds specified in the "Cache Timeout" setting (defaults to 5 minutes). After this time has ellapsed, you can turn NuSEO.PHP's HTO back on.

Upgrading NuSEO.PHP

  1. Make a backup of the configuration file named nuseo_config.php. The upgrade process will not overwrite it, but it is always good to have a backup handy.
  2. Upload NuSEO.PHP files. There are two ways to upgrade your server files:
    • One step upload. This method is simple. Just overwrite the files on the server and that's it. However, since it can take a while to upload all of NuSEO.PHP, your site may experience some down time while NuSEO.PHP has not been uploaded completely. This is the recommended method for its simplicity.
      • Using an FTP Client upload the directory named nuseo found in the installation package to your server root (for instance, if your server root is public_html, then nuseo will be installed in public_html/nuseo). This will not overwrite your settings and configuration
    • Six steps upload. This method is more long winded and complex. It should be used when it is imperative to reduce down time caused by the upgrade process to a minimum.
      • Extract the installation package to your local computer, and rename the directory named nuseo to nuseo_new.
      • Download the file named nuseo_config.php from your server's nuseo directory into your local computer's nuseo_new.
      • Upload the directory nuseo_new to your server document root.
      • In the server, rename the nuseo directory to nuseo_old
      • In the server, rename the nuseo_new directory to nuseo
      • Verify that your site is working 100% correctly. And optionally, delete the nuseo_old directory.
  3. If you are using NuSEO.PHP vBulletin Module, re-import the corresponding product XML found in the new installation package (Set overwrite to yes, while importing the new product file).
  4. Log into NuSEO.PHP Admin CP and click save. This step is important as new settings and features may have been added and may require initialization.

Uninstalling NuSEO.PHP

  1. Disable NuSEO.PHP. Undo the changes made to the .htaccess file during the installation. If you simply copied NuSEO.PHP's factory .htaccess, then you can simply rename it or remove it. If you have made changes to this file, please make a backup, in case you need to refer to these in the future.
  2. Remove NuSEO.PHP files. If you would like to remove NuSEO.PHP, delete the nuseo folder from your web server. Make sure that the .htaccess file has been removed or edited to not include nuseo.php
  3. phpFox Only: Undo the changes made to the file named include/settings/server.sett.php, and restore phpFox's original .htacces file, if any.
  4. vBulletin Only: Uninstall NuSEO.PHP's vBulletin Product. Go into vBulletin Admin CP > Plugins & Products > Manage Products. Next to NuHIT - NuSEO select 'Uninstall'