Table of Contents


Installation

Installing URL2Go Pro is very easy, and requires hardly any PHP knowledge.

The first step is to download the script from TPG PHP Scripts. Make sure you have your CustomerID ready, because you'll need it to access the download area.

Once you've downloaded the script, unpack the archive, and store the files somewhere on your hard drive, for example C:\URL2GoPro\. There will be two directories, called 'upload' and 'docs', and a few files, such as README.TXT and LICENSE.TXT.

Now go to the 'upload' directory, and you should see a file named 'config-sample.php'. Open it in a text editor (e.g. Notepad), and edit the necessary values. The most important things you should edit are the MySQL user, password and database name. Once you've made all the changes, save the file as 'config.php'. This is very important, and cannot be skipped.

To setup the script on your server, you should upload all the files in the 'upload' directory, using your favorite FTP program. Make sure that you upload all the files in the upload directory.

Once all the files are uploaded, all you need to do is use your favorite web browser (such as Internet Explorer) to open the location where you uploaded the files. For example, if you've uploaded the files to a directory called 'url2gopro', you should open http://www.yourwebsite.com/url2gopro/.

To start the installation process, click on the 'click here to start the installation' link. You will then be taken to the web-based installer.

During the first step of the installation, you will be asked to enter your TPG PHP Scripts CustomerID to verify that you are a licensed customer and it prevents others from running the installer.

After entering your CustomerID, you will be taken to step two, where the necessary database tables for URL2Go Pro are created. You don't have to do antything at this step, and a link to the next step will appear when all the tables have been created.

Step three will insert all the default data, such as site templates and settings. Like the previous step, you won't have to do anything at this step, and a link will appear at the bottom when everything has been inserted.

Step four, which is the final step, is used to setup your short URL website. You will have to enter the URL of your website (although the installer tries to auto-detect it for you), and you will also have to set a username and password for the admin control panel.

Once you've finished that step, you are completely done, which means you can start using your short URL. The first thing you should do is login to the admin control panel, and get familiar with it, so you know how everything works. 


Installation - Short Version

If you've got plenty of experience with setting up scripts, then you should follow the steps below. If you don't understand it all, use the normal installation guide.

  1. Download the script from TPG PHP Scripts
  2. Unpack it on your computer
  3. Find the config-sample.php file in the 'upload' directory
  4. Change the values in the config-sample.php file, and save it as 'config.php'
  5. Upload all the files (in the upload directory) to your server
  6. Open up the location where you uploaded the files, e.g. http://www.yourdomain.com/url2gopro/.
  7. Follow the steps of the web-based installer
  8. All done! Once you've finished the installer, the script is completely installed.

Managing short URL's

The most important part of URL2Go Pro are the short URL's that visitors create, and the admin control panel has a section where you can manage all the short URL's, located under the "View short URL's" menu.

This section allows you to add your own short URL's, edit existing short URL's, view the moderation queue, and more. Check out the sub-articles for more information on each action. 


Adding new short URL's

It's possible to create new short URL's yourself through the admin control, instead of using the public form meant for visitors.

There are no restrictions when creating a new short URL through the admin control panel. For example, if you've banned adult short URL's or enabled moderation, it's still possible to create adult short URL's through the admin control panel, since all restrictions don't apply to the admin control panel. This means that you, as administrator, can always create short URL's.


Viewing all short URL's

When you click on the "View short URL's" you will be taken to a list fo all the short URL's that exist in the database. By default the 25 latest URL's are shown, but it's possible to view older URL's by using the paging links (e.g. "Next Page >>").

It's also possible to view all the URL's in the moderation queue, by  clicking on the 'moderated' link, which is positioned above the list.

The list of URL's contains the basic information on each URL. You will be able to see the full URL, which has been truncated to fit the page. You will also be able to edit and/or delete each URL by clicking on the edit or delete link.

It's also possible to mass-moderate URL's, by using the checkboxes and the form below the list. You can check a few specific URL's, and then use the form to approve, disapprove or delete them all. Please note that you don't get any confirmation when mass-moderating, so be careful with deleting any URL's.


Editing short URL's

When you click on the 'Edit' link when viewing the URL's, you will be taken to a form where you can edit the URL you wanted to edit.

The edit form is almost exactly the same as the form used when adding a new URL. You can change most of the information of the URL, and when you click on the 'Save URL' button the information will be updated immediately. 


Deleting short URL's

When you click on the 'Delete' link, you will first be taken to a confirmation page, where you must confirm that you want to delete that particular URL. This is to prevent any accidental deletions.

Once you've confirmed the deletion, the URL will be removed immediately, and can no longer be used. If the URL had a custom name, that name becomes available again.

If you want to delete multiple URL's, it might be easier to use the mass-moderation tools, although you have to be careful, since there won't be any confirmation when using the mass-moderation tools. 


Website Templates

URL2Go Pro uses templates to build up the website (where users can create their own short URL's). This means that it's possible to completely change the way your website looks, and gives you unlimited amount of flexibility.

There are several standard templates, which cannot be deleted since they are very important. These templates can be edited to match the look of your website or to use a complete different design.

It's possible to use PHP in your templates, and the default templates already have some PHP coding in them to control certain elements.

It's highly suggested you take a look at how the templates work, before trying to edit them, since you could break your website if you miss out certain things. 


Adding new templates

It's possible to add your new templates, although there is hardly any reason to, unless you're using custom PHP pages which uses the template system.

To add a new template, go to the 'Templates' menu, and then click on the 'Add new template' link. You will then be taken to a form where you will find four form fields: title, html/php, description and the template name. 

The title and name fields are required, and the other two are optional (although you might want to enter some HTML or PHP, since that's the whole point of a template). The template name is used by the template system to display a template, and should be fairly simple. 

Note: the description and template name can be found under the 'Advanced Options', at the bottom of the page 

Once you've filled in everything you wanted to fill in, click on the 'Add  Template' button to save your new template. If everything went okay, you should be redirected to the list of templates, where your new template will also appear now.


Viewing templates

A list of all the templates can be viewed by clicking on the 'Templates' menu. A title and description for each template will be displayed for each template, along with a Edit and Delete link.

The delete link won't appear for every template, and will only be shown if it was a template that you added. The standard templates cannot be deleted, since they are vital for the script, and are absolutely necessary.


Editing Templates

When you click on the 'Edit' link, you will be taken to a form where you can edit the template title and change the HTML/PHP of the template. If it's a custom template, you will also be able to change the description and name.

After you've finished making changes, click on the 'Save Template' button to save the changes, and you will be redirected back to the edit form, with a success message at top.


Deleting Templates

When you've clicked on the 'Delete' link, you will be taken to a confirmation page, where you must confirm the deletion.

Once you've confirmed the deletion, the template will be deleted, and can't be used anymore. After deletion, you will be redirected to the template list.

Deleting a template cannot be undone, and the template is lost forever!

It's not possible to delete the standard templates, unless you're running DEBUG MODE, and it's highly recommended you NEVER delete the standard templates, because the script will most likely stop working when the standard templates are deleted. 


Settings

To change the way your website works, go to the Settings section (by using the 'Settings' menu) where you can change various things about your website. Each setting is explained below:

General Settings

Admin CP Settings

Redirect Options

Moderation Options

When you are done changing the settings, scroll to the bottom of the page and click the 'Save Settings' button to save the changes you made.

Misc

This article, and its sub-articles, are used to describe some miscellaneous parts of URL2Go Pro, which didn't fit into other articles.

Enabling DEBUG MODE

If you want to be able to delete standard templates, or perform certain other developer tasks, you will have to enable DEBUG MODE. The following steps must be taken to enable DEBUG MODE:

  1. Open global.php in your favorite PHP/text editor (global.php can be found in the includes directory).
  2. Find line 4, which looks like this:

    if (BUILD_RELEASE == 'yes') { define ('RELEASE', true); } else { define ('RELEASE', false); }

    and delete it.

That's all, DEBUG MODE should now be enabled.

Please be very careful with DEBUG MODE, because it enables some things which can completely destroy your website, or reveal "confidential" information (like information about your webserver). 


Support & Feedback

If you need any support with URL2Go Pro, please use our support system, which can be accessed on our website.

If you've got any suggestions for URL2Go Pro, please use the Community Support Forums, which we regularly read, and post on. We prefer having suggestions posted publicly in the forums, because others will be able to comment on the suggestions, and this eventually leads to a better suggestion.

It's also possible to e-mail us, by using the contact form on our website.


License

URL2Go Pro License Agreement

URL2Go Pro ('The Software') is a copyrighted work of authorship, and is protected under copyright and intellectual property laws. The Software is copyright (c) 2006 Dennis Pallett ('The Author').

By installing and using URL2Go Pro on your server, you agree to the following terms and conditions:

- This license grants you the right to run one instance of the Software on one webserver and on one website. For each installed instance of the Software a separate license is required.

- You may not transfer, sell or give the Software to anyone else, without written permission from the Author.

- Distribution of the Software is strictly prohibited.

- A second additional instance may be setup strictly for testing purposes only. This second instance must not be viewable by the general public, and should therefore be password protected.

- When this license has expired, the Software must be removed from your webserver, or a new license must be purchased.

- The Software may not be used for any illegal activity, including, but not limited to, software piracy, violation of trademarks, servicemarks, or other copyright infringements.

- If any of the terms in this license are violated, the Author may revoke the license at any time.

- Refunds may be given by the Author, however this is decided on a case-by-case basis, and refunds are not guaranteed.

- The Author reserves the right to change these terms at any time. You will be properly notified when this happens.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.