oXygen WebHelp with Feedback for @PRODUCT_ID@ @PRODUCT_VERSION@ was generated successfully!

Output location

The folder containing the generated output is: @FOLDER_OUTPUT_PATH@.

oXygen WebHelp Requirements

Installation Instructions

In case you already have a web server configured with PHP, MySQL, please jump directly to Deploy the WebHelp output.

Otherwise, read how to get started with XAMPP, a bundle containing the required software (Apache HTTP Server, PHP and My SQL). The installation is straight forward and should take under 20 minutes.

  1. Install XAMPP. Download and install the XAMPP package:
    1. Download XAMPP, for instance for a Windows system: http://www.apachefriends.org/en/xampp-windows.html.
    2. Install it in C:\xampp.
    3. From the XAMPP control panel, start "MySQL", and then "Apache".
    4. Check that the HTTP server is working. For this try opening in your browser: http://localhost/xampp/index.php .
  2. Prepare the MySQL database.

    Create a new database for the feedback system and a MySQL user with privileges on that database. The feedback system uses the MySQL user to connect to the database.

    Prerequisites: The user name and password for the database administrator. For XAMPP, the defaults are root with an empty password. We will use phpmyadmin to create a new database.

    1. In your browser go to: http://localhost/phpmyadmin/
    2. Click on Databases tab in the right frame and then create a new database. Name it as you like, for example can be named comments.
    3. Create a new user with connection privileges for this database. Select the SQL tab and paste the text below. Make sure you change the user_name and user_password values. INSERT INTO `mysql`.`user` (`Host`, `User`, `Password`, `Select_priv`, `Insert_priv`, `Update_priv`, `Delete_priv`, `Create_priv`, `Drop_priv`, `Reload_priv`, `Shutdown_priv`, `Process_priv`, `File_priv`, `Grant_priv`, `References_priv`, `Index_priv`, `Alter_priv`, `Show_db_priv`, `Super_priv`, `Create_tmp_table_priv`, `Lock_tables_priv`, `Execute_priv`, `Repl_slave_priv`, `Repl_client_priv`, `Create_view_priv`, `Show_view_priv`, `Create_routine_priv`, `Alter_routine_priv`, `Create_user_priv`, `Event_priv`, `Trigger_priv`, `Create_tablespace_priv`, `ssl_type`, `max_questions`, `max_updates`, `max_connections`, `max_user_connections`, `plugin`, `authentication_string`) VALUES ('localhost', 'user_name', PASSWORD('user_password'), 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'N', 'N', 'N', 'N', 'Y', 'Y', 'Y', 'Y', 'N', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'N', 'Y', 'Y', 'Y', '', '0', '0', '0', '0', '', '');
    4. Click on Users tab in the right frame and then, at the bottom of the page, click on the reload the privileges link.
  3. Deploy the WebHelp output.
    1. Locate the directory of the HTML documents. For this, open in your browser: http://localhost/xampp/phpinfo.php and see the value of the DOCUMENT_ROOT variable. For instance, if you installed XAMPP in C:\xampp, it will be: C:/xampp/htdocs
    2. Copy the transformation output folder (@FOLDER_OUTPUT_PATH@) to the DOCUMENT_ROOT.
    3. Rename it to a relevant name - we'll use as a sample @PRODUCT_ID@.
    4. Open http://localhost/@PRODUCT_ID@/oxygen-webhelp/feedback/install/.
      1. Verify that the prerequisites are fulfilled.
      2. Press Start installation.
      3. Configure the email addresses, and database user and password - the ones created in step 2.3. Select the Create new database structure - but only if you perform a new installation! Enter the WebHelp system administrator password. This special user will be able to moderate new posts and manage other WebHelp users.
      4. Press Next Step.
      5. Remove installation folder from your web server.
      6. Click on the link pointing to the index of the documentation, or visit: http://localhost/@PRODUCT_ID@/.
      7. Test your system. Create a new user or post as anonymous. Check that the notification emails are delivered to your inbox.