|
|
 |
eBackup - Website Server Back ups
- Requirements
- Configuration
- Installation
- License and Disclaimer
- Settings
- Back Up Page
- Restoration
- psjs_datalogs
- Changing your password
Requirements
This script requires Perl on either a UNIX or WINDOWS server, and the following Modules :
Archive::Zip
Compress::Zlib
These modules subsequently require a few additional Modules, however if the above two are installed, the remainder are almost always installed. If you're missing either of the above two modules, contact your Web Host and ask if they will install the modules for you. Some will honour your request, some will not. We cannot install the modules for you because root access to the server is required. We can however offer you Hosting with the required modules installed.
If you have Compress::Zlib installed, but not Archive::Zip, you may be able to get away with installing Archive::Zip in the same directory as eBackup. This would require some additional files and custom installation for which a non-refundable fee applies.
As this is a free script offered to you by us, our standard "No support" policy applies. We plan to develop a Commercial version with additional features including Timed automated back up and Zip file delivery (will require a Cron tab), Automated restoration including file permissions, Favorite directory selections, History tab, Back up manager and Regulated back ups for larger data repositories. If you desire any of these features, or support for the Free version, our standard custom programming fees will apply.
Configuration
This Script requires no Configuration, however if you have trouble installing the Script, you can hard code some values in the _key.cgi file.
Installation - Linux/Unix/Mac Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Setting the Path to Perl. Open all CGI Scripts (except [script]_key.cgi) in a Plain Text Editor and make sure the first line of the CGI Script is the Path Perl for your server. Most Users can skip this step being the default Path to Perl shipped in the CGI Script is very common.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled
directory and CHMOD
all the CGI Scripts to 755. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you forget to CHMOD all CGI Scripts to 755, Step 3 will
yield a Server 500 Error.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems with the Setup Routine follow the instructions returned by the Script.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Linux/Unix/Mac Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Error. This most often occurs because Step 2 was not followed precisely. Make sure the CGI Scripts you are uploaded are CHMOD to 755, the folder the CGI Scripts reside in is also CHMOD to 755, and the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
Do NOT enter the CGI Script name, do NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. CHMOD it to 755 then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "/www" or "/httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. For example:
$DefaultData = "/var/username/www/htdocs";
Finally, on some Server's it's necessary to CHMOD the folder just above your WebSpace to 777 granting permission to the CGI Script to create the Required Directories at WebSpace Level. In the example above, the "htdocs" folder would need to have it's permissions set to 777.
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form.
Installation - Windows Servers
[script] refers to the first portion of the name of the CGI Scripts you purchased.
- Your Windows Server may not execute CGI scripts even if Perl is Supported. Many Server Administrators do not modify the Registry to accommodate Scripts with a .cgi extension. In this case, contact us for a copy PL Version.
- Setting the Path to Perl. Your Server may or may not require the Path to Perl. It's highly likely you don't need it, and you can ignore this Step. However you may want to check with your Host if you can not load the Setup Script in your web Browser.
NB: if you do not you a Plain Text editor such as Windows NotePad or Mac Textedit (in Plain Text Mode), your Text/HTML editor will add extraneous code to the CGI Script when you save it which will result in a server 500 Error.
- Upload all CGI Scripts to your cgi-bin or any cgi enabled directory. It is imperative that you upload (transfer) all CGI Scripts to your server in ASCII mode.
If you do NOT upload (transfer) all CGI Scripts to your
server in ASCII mode, Step 3 will yield a Server 500 Error.
- Load your Browser, point it to the [script]_setup.cgi file and follow the on-screen instructions for installation. For example, in your browser, type :
http://www.yourdomainname.com/cgi-bin/[script]_setup.cgi
- Enter a Username and Password. This will be your Username and Password for the Administration Section. If the Setup Routine is successfully processed a link to the Administration Section will appear on the resulting page. Click the link to access the Administration Section with the Username and Password you just entered in the Setup Script.
Should you encounter any Permission problems during the Setup Routine, you need to contact your Host and request "Full Read/Write Permissions" be applied to at least one folder on your Server. Many Servers have at least one writable folder, often named "database". See Common Installation Problems below for more information.
Upon successful completion of the Setup Routine the [script]_setup.cgi_setup.cgi script attempts to delete itself. This ensures the Setup Routine can not be repeated by another Surfer who would effectively reset your Administration Section Username and Password. Manually delete the [script]_setup.cgi
CGI Script you uploaded if the Setup Routine could not automatically
delete it (Refresh your FTP directory listing to check).
Should you ever forget your Administration Section Username and Password you can repeat this Step to set a new Username and Password.
Common Installation Problems - Windows Servers
NB: Shared Secure Servers, VPS, SBOX and Free Servers.
- Server 500 Errors are usually misleading on Windows Servers. It seems to be the default error page for just about every error. Make sure you typed in the correct Website Address (URL) to the CGI Scripts on your server. Make sure the CGI Scripts were transferred in ASCII Mode. Auto-Detect only detects the extensions you specify in your FTP client's Settings.
- I can initially load the Setup Script and punch in my Username and Password, but when I submit the Form, I receive 404 Error Page or an alternate Error Page stating "Page Cannot be found".
This suggests your Server is operated by a very nervous System Administrator employing strict security measures, you're using a Shared Secure Server which dynamically sets your domain name to something other than the a standard Top Level Domain (www.yourdomainname.com) or sbox is employed by your server.
In any case, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and enter the URL to the folder you uploaded the CGI Scripts to in the $SecureServer Variable. If you uploaded the CGI Scripts to your cgi-bin, then you'd set the following:
$SecureServer = "http://www.yourdomainname.com/cgi-bin";
Do NOT enter the CGI Script name, do NOT enter a trailing slash. After setting the Variable refresh the Setup Routine's Page that asks you to enter your Username and Password. Unless you refresh the initial Setup Page, the Form's URL will not be updated to reflect your Variable value.
- I cannot find the correct path to my WebSpace or the required Data Directories and/or Password file cannot be created.
You need to find that Path. Ask your host, or Download a copy of our free E-Vars CGI Script and install it on your server. You will need to rename the E-Vars CGI Script to "myserver.pl" if your Server only executes Scripts with .pl extensions. Upload it to your cgi-bin or any cgi executable folder then load it in your Web Browser which will print your Server's environment variables and other useful information. Determine your Server's Document_ROOT or Absolute Server Path to the folder your home page (index.html) resides in. You may need to append "\\www" or "\\httpdocs" to your Document_ROOT or Absolute Server Path to complete the path to your Writable WebSpace.
Once you've determined your Absolute Server Path, open [script]_key.cgi in Plain Text Editor (not a WYSIWYG Text Editor, nor a Rich HTML Editor) and set the $DefaultData Variable. Be sure to separate folder names with two backslashes, not one slash. For example:
$DefaultData = "C:\\html\\username\\htdocs";
- We offer a very reasonably priced Custom Installation Service. We'll Setup the CGI Script for you and send you the Log in details which you can update at your own leisure. If we cannot successfully Setup the CGI Script we will refund both the Installation fee and the purchase price of the CGI Script. To Order Custom Installation, please fill in our Secure Installation Order Form.
License and Disclaimer
The following constitutes an agreement between you (the end user/purchaser) and us, PerlScripts JavaScripts.com (a wholly owned subsidiary of InterActive Scripts). By purchasing and using our software, products or services you agree to and accept the licensing agreement stated on this page. All documentation, goods and services are provided "as is" and without warranty. We hereby disclaim all warranties relating to any documentation, goods and services, whether express or implied, including warranties of suitability. In no event shall we be liable for any direct, indirect or consequential damages resulting in loss of revenue or data, incurred by you or any of our products, information or services. We reserve the right to revise the terms and conditions stated on this page at any time without notice. You agree to be bound by such revisions, and you are encouraged to periodically revisit this page to review the then current terms and conditions.
We grant you the right to use one copy of the software, product or service purchased, for testing and familiarization purposes. We also grant you the right to implement, install and use one copy of the software, product or service purchased on a single web site domain for use by one entity once the evaluation copy is removed / deleted.
By purchasing a product you are also subscribing to our periodic newsletter which will notify you of new software releases, updates and special offers. In accordance with United States and International anti-spamming laws, an unsubscribe link that removes you from all future mailings will accompany each e-mail notification.
For taxation purposes, we must keep accurate transaction and installation records. At the time of software installation, you will be asked to enter information such as your web site's domain name and your product's serial number. This information is used to validate copies of our software.
We reserve all rights. Written permission must be obtained from us before you may copy, reproduce, publish, modify or alter in any way, any media, software, documents or products, in part or in whole, contained within our web site or traded by us. All media, software, documents and products are the property of PerlScriptsJavaScripts.com. We retain ownership and copyright of software products purchased from us and all copies of the software. As a licensee you may make one copy of the software product solely for backup purposes. Removal of any copyright messages, publicly visible or otherwise without prior written permission from us is expressly forbidden. Unauthorized reproduction of any of our software, documents or products is prohibited by Federal and International laws and subject to criminal prosecution.
Any use of software and accompanying documentation on our Web site is subject to the terms of a software license agreement between you and us. You must read this license agreement in it's entirety and agree to it's terms prior to installing or using the software. All ownership rights and rights not implied are reserved. We reserve the right to revoke these permissions and terminate this agreement at anytime or at it's own discretion without reasonable notice. We reserve the right temporarily or permanently discontinue any software product or the support associated the product at anytime or at it's own discretion without reasonable notice. You agree and accept that we shall not be liable to you or to any third party for any such cessation.
You agree that any issue or dispute that may arise between PerlScriptsJavaScripts.com and yourself in respect to this web site or it's goods or services will be resolved and governed by and within the courts and laws of Melbourne Australia. If your local laws do not allow for such an agreement, you must delete all copies of products supplied to you by us and you are hereby notified of the termination of this license.
Settings
eBackup's Settings direct the aesthetical appearance of the program, set the default functionality and synchronize the server's clock with your local time.
Click on each of the Gray colored links found on the Settings page for more information. Configure eBack up to suit your preferred functionality. You can revisit the Settings page as often as you like to fine tune the program's Configuration. Once you've entered your preferences, scroll to the bottom of the page and press the button labelled "Save Settings" to record the changes.
Back Up Page
All back up processes are issued and commenced from the "Back up" page. If you have a large amount of data to back up, we suggest you create several Zip files rather than one Zip for all of your directories. The actual amount of data that can be backed up depends on your server's resources and how much are available. Use your own judgement and check the generated Zip file to ensure it's contents are as expected. Keep in mind also that most Web hosts and ISPs impose limits on the size of e-mail messages. Zip files generated by eBackup are compressed at the highest possible level (creating the smallest possible file size).
The selected directories are created and stored within the Zip file (even though it may not appear as though they are until you extract the contents). You may not see the directory names when browsing the contents of the Zip file, you'll need to extract the contents of the Zip file to reproduce the directory structure.
To Back up your data :
1. Click the Back up link in the Main Control Panel
2. Select either one Directory form the first list, or multiple directories from the second list.
3. Select whether or not the Zip file should be e-mailed
4. Enter the path to a directory the Zip file should be stored in
5. Enter a name for the new Zip file
6. Press the button labelled "Back up"
Notes :
- If this is your first Back up select 2-3 of your smaller directories. If using a PC, hold down the Control key to select multiple directories.
- eBackup attempts to create the path entered in the "Store in" field, however will only succeed if the final directory in the path is one level above your web space. Use the default setting the first time around.
- Do not enter the file extension in the "New Zip file name" field. The extension (.zip) is appended to the file name by the script.
- If you're using one of our many scripts, you should regularly back up the "/psjs_datalogs" directory, found in the same directory your home page resides in, and every sub-directory contained with in it. If you're using one of our Upload scripts, Attachment Mailer or any scripts that supports File Uploads, you should also back up the folder that contains the Uploaded files.
Check the new Zip file's contents by decompressing the file to a directory on your hard drive. You'll need decompression software such as WinZipTM. Make sure the extracted contents match the selected directories, and that each directory contains files with data.
Restoration
eBackup does NOT support automated restoration of data. If you've backed up permission reliant documents (such as CGI scripts or data files) and you're restoring the files to a web server, you will need to manually set permissions on those files using CHMOD. If you're extracting the contents to your local hard drive, permissions are irrelevant.
To restore files, you must upload them as you normally would, using an FTP client such as WS FTP or CuteFTP.
If restoring data files backed up from the "/psjs_datalogs" directory created by our scripts, be sure that once uploaded, the "/psjs_datalogs" directory and every directory contained with in it is CHMOD to 777.
psjs_datalogs
If you're using just about anyone of our scripts (free or commercial), you'll have a directory at web level named "psjs_datalogs". The psjs_datalogs directory contains data files such as your templates, encrypted password for the Admin section, member profiles as well as other data generated by the scripts. All scripts house data inside sub-directories of the psjs_datalogs directory. For example, if you are using easy Poll, eSurvey and eBackup, you will have a directory structure that looks similar to the following :
/home/user/public_html/psjs_datalogs
/home/user/public_html/psjs_datalogs/ebackup1111111111
/home/user/public_html/psjs_datalogs/ebackup1111111111/data
/home/user/public_html/psjs_datalogs/esurvey1111111111
/home/user/public_html/psjs_datalogs/esurvey1111111111/data
/home/user/public_html/psjs_datalogs/esurvey1111111111/default
/home/user/public_html/psjs_datalogs/ebackup1111111111
/home/user/public_html/psjs_datalogs/ebackup1111111111/data
where "1111111111" is the $FolderPass variable you set in the _key.cgi file to protect your data from prying eyes.
It's the psjs_datalogs directory (and all sub-directories) that you want to make back ups of. When in eBackup, on the Back up Page, select all directories that have psjs_datalogs in the path, they will be listed one underneath the other because the listing is sorted and displayed alphabetically. Save all psjs_datalogs directories to the one Zip file and e-mail it to yourself for safe keeping.
If for some reason, you ever lose any data associated with anyone of our scripts, and it does happen, you'll be able to restore the data from your latest back up.
If you're moving web hosts
and have a very recent back up (i.e. you just made it in anticipation of the pending move), upload the entire psjs_datalogs folder from the back up zip to your new web server. Make sure you upload it to your web level folder. And make sure you CHMOD all directories and sub-directories to 777 on the server. Once you've uploaded the associated cgi scripts and CHMOD them to 755, you should be able to log in using your same username and password. The cgi scripts can be uploaded to any executable folder. They will find the data files. If they do not find the data files (you'll know this is the case if your username/password are rejected), make sure the $FolderPass in the _key.cgi file matches the $FolderPass in the script's associated directory name of the first sub-directory below psjs_datalogs. For example, if working on the restoration of eSurvey :
$FolderPass = "SecretPass";
in the esurvey_key.cgi file must match
/home/user/public_html/psjs_datalogs/esurveySecretPass
If you're wanting to restore only selective files
you must first establish which files are to be restored in order to prevent any undesired overwriting data files. The following file names are commonly used throughout most scripts and may help you locate the files you need.
- adminpass.file and adminpass.bak
- Both these files store your username and encrypted password for the admin section. If you've lost or forgotten your log in details, search our site for "Lost Pass" which will direct you to a page that guides you through the resetting of your log in details
- details.list and details.bak
- Both these files store details of any forms, polls or surveys created. i.e. the information you see on the "Summary" Page when you log in to the script.
- profile.list and profile.bak
- Both these files store member profiles.
- config.ftf and config.bak
- Both these files store your selected Settings for the script.
- headerdata.list and headerdata.bak
- Both these files store your custom headers
- footerdata.list and footerdata.bak
- Both these files store your custom footers
- amdtemplate.list and amdtemplate.bak
- Both these files store your custom e-mail notifications
- artemplate.list and artemplate.bak
- Both these files store your custom customer's e-mail notifications
Notes :
- If you're using a script that uploads files to your server, such as Upload Pro or Attachment Mailer, do not forget to back up the directories you've set as the upload directories. These usually default to directories named "uploads" or a variant such as "pro_uploads", also located at web level. The "uploads" directories however store no data other than file uploads, so they are not imperative to the functionality of the scripts.
- If you're using Build a FAQ, Build a FAQ Plus or Build a FAQ Pro, you should also back up the directory named "ourfaqs" (named "psjs_faqs" in earlier versions) or the name you assigned in the Settings for the FAQ folder. It houses the generated public HTML documents. i.e your website's FAQs. This folder is also located at web level.
- If you're using a script that supports multiple forms/surveys/polls etc. each form has it's own sub-directory located two levels below the psjs_datalogs directory. The name of the directory corresponds with the form's ID found in the details.list file (e.g. 1027265242). Each directory stores it's own data files associated with the form. i.e. the submissions and config files.
Changing your password
Enables you to update or change the Administration log in details. Enter your current log in details, enter your new log in details and press the button labelled "Change Pass".
|
|
|
